Midrange News for the IBM i Community

Posted by: Bob Cozzi
Rogue Programmer
Cozzi Productions, Inc.
Subprocedure Documentation Options
has no ratings.
Published: 12 Nov 2012
Revised: 23 Jan 2013 - 2185 days ago
Last viewed on: 14 Jan 2019 (3545 views) 

Using IBM i? Need to create Excel, CSV, HTML, JSON, PDF, SPOOL reports? Learn more about the fastest and least expensive tool for the job: SQL iQuery.

Subprocedure Documentation Options Published by: Bob Cozzi on 12 Nov 2012 view comments(5)

I'm releasing the final version of COZTOOLS next month and the question of Documentation format came up.

For the CL Commands, it was very easy. We use the online helptext (produced by press F1 when the command is prompted) as the help text. As the online help is updated, we purge the existing HTML file and the next time someone views it, the new HTML is generated from the helptext.  I think it works great.

For Subprocedures, however, there isn't any automatic way to document them and their parameters, consistently, that I know of. Have any of you come across a standard way to document these things? I don't mean something you've written yourself, but rather some sort of automated methodology; perhaps something that reads the Prototype source and generates the helptext accordingly, anything like that?


Return to midrangenews.com home page.
Sort Ascend | Descend