Contact | Privacy Policy
 
Join us for the next RPG & DB2 Summit
October 17-19, 2017 in Minneapolis
Sponsors & Special Offers
News Headlines
March 27, 2017
SAVE THE DATE! Join us in Minneapolis October 17-19, 2017 for the next RPG & DB2 Summit!
December 5, 2016
RPG & DB2 Summit attendees see tangible results of their education
December 5, 2016
Summiteer Ake Olsson describes modernization journey
May 17, 2016
20th RPG & DB2 Summit Teaches Latest OLAP, Temporal Capabilities in DB2 for i
February 10, 2016
Gantner, Paris & Tuohy each earn 2016 IBM Champion honor.
January 12, 2016
New IBM i DB2 Track Debuts at March 2016 Summit

RPGLEDOC - Document Procedure and Program Calls

Modern RPG applications consist of a multitude of subprocedures and programs - a lot more than there were in the traditional RPG applications. Although modern tools, such as the outline view in Remote System Explorer, can provide me with a list of callable subprocedures and programs, they cannot tell me exactly what the subprocedure/program does, what the possible values are for parameters or what the possible return values are.

Which leads to that terrible four lettered word - documentation. Yes, it all has to be documented and we all know how much RPG programmers like to write documentation.

This is a problem which has already been tackled in Java, PHP and other languages. JavaDoc and PHPDoc offer a facility whereby programmers put special comments in their code and a command is used to scan the code and generate documentation web pages from the comments.

Can the JavaDoc approach be used in RPG? By applying a few terms and conditions, of course it can.

RPGLEDOC comes in two parts - a set of programs to generate the RPGLEDOC documentation and examples of how you might view the contents of the documentation using either CGIDEV2 or PHP.

Each of the downloads is a zip file containing a directory. Each directory contains a READ_ME document which contains details on how to install and use the programs

Please note that these are not supported products - the source of the programs is included and you are free to chop and change them as you wish (see standard disclaimer below). Of course, if you come across any bugs please let us know

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

More Downloads

Stay on top of download updates, new freebies and other news. Subscribe to our Email Alerts!
* (required field).

Email*
Re-Enter Email*
First Name
Last Name
List Choices *




You will receive a notification e-mail when you subscribe to the Mailing List

  • You may unsubscribe from our list at any time and we will immediately remove you.
  • We will never share your e-mail address or other personal information with any third party company without your express permission.
Home | Conferences | About Us | System i Community | Privacy Policy | Legal Notices | Email Webmaster | Contact
System i Developer,LLC © 2014