RPGLE Procedure Documentation (CGIDev2)
How this was generated
"
All the required data is in two copy members BASEDATA and PROTOTYPES. Both of these members are in the source physical file TESTCPY in the RPGLEDOC library. The important one is PROTOTYPES which contains all of the "special" documentation comments.
The documentation process extracts the definitions and comments and places then in database tables. These pages show you the results of what was extracted from the copy members
BASEDATA
d errorStatus s n
d b_Product ds Qualified
d based(dummy_ptr)
d productCode 7a
d description 30a
d stock 10i 0
d value 9p 2
d overview 500a varying
d lastSoldDate d
d lastSoldTime t
d enteredSystem z
d checkCredit n
d b_BuyProducts ds qualified
d based(dummy_ptr)
d buyingPrice 9s 2
d product likeDs(b_Product)
d b_oldProduct ds qualified
d based(dummy_ptr)
d productCode 7a
d description like(b_Product.description)
d YES C 'Yes'
d NO C 'No'
d MAYBE C 'Maybe'
d CONVERSION_RATE...
d C 1.00000
d fileId s 10i 0
PROTOTYPES
//**/ @desc Retrieve the description of a product
// @author Paul Tuohy
// @param Product Code
// @param Description of Product <br />
// Has a special value of "*** NOT FOUND *** if
// the product is not found
// @category application
// @category getter
d getProductDescription...
d PR
d productCode Const
d like(b_Product.productCode)
d description like(b_Product.description)
//**/ @desc Retrieve the description of a product
// @author Paul Tuohy
// @return Description of Product <br />
// Has a special value of "*** NOT FOUND *** if
// the product is not found
// @param Product Code
// @deprecate getProductDescription
// @category application
// @category getter
d getNewProductDescription...
d PR extProc('getNewProductDescription')
d like(b_Product.description)
d productCode Const
d like(b_Product.productCode)
//**/ @desc Retrieve product data. The data is restored from
// multiple tables. The stock figure reflects any
// pending orders.
// @author Paul Tuohy
// @return True if product was found <br />
// False if product was not found
// @param Product Code
// @param Structure of Product Data
// @category application
// @category getter
d getProductData...
d PR n
d productCode Const
d like(b_Product.productCode)
d productData likeDs(b_Product)
//**/ @desc Set the buying price for a product
// @author Paul Tuohy
// @return False if product was added/updated successfully <br />
// True if product was not added/updated successfully
// @param Product Code
// @param Structure of Product Buying Data
// @category application
// @category setter
d setProductData...
d PR n
d productCode Const
d like(b_Product.productCode)
d buyingData likeDs(b_BuyProducts)
d Const
//**/ @desc Set product data.<br /> The stock and value figures
// will be ignored by this procedure. <br />Stock and
// value figures must be adjusted using the
// Stock Adjustment System
// @author Paul Tuohy
// @return False if product was added/updated successfully <br />
// True if product was not added/updated successfully
// @param Product Code
// @param Structure of Product Data
// @category application
// @category setter
d setBuyingPrice...
d PR n
d productCode Const
d like(b_Product.productCode)
d productData likeDs(b_BuyProducts)
d Const
/if defined (doutility)
//**/ @desc Clear all stored message
// @author Paul Tuohy
// @category utility
d clearMessages PR extPgm('CLRMSGS')
//**/ @desc Retrieve the stored message at the requested
// position
// @author Paul Tuohy
// @param Position of the message to retrieve
// @param Message Text
// @param Message Severity
// @category utility
d getMessage PR
d forMessage 10i 0 Const
d msgText 80a
d severity 2a Options(*NoPass)
//**/ @desc Convert a string to uppercase
// @author Paul Tuohy
// @return An uppercase string
// @param A mixed case string
// @category utility
d toUpper PR 100a
d lineIn 100a Const
/endIf
The RPGLEDOC command was used to generate the documentation as follows:
