PBDoc Example using Code Review Template Review Sheet v1.0
Object: gf_dosomething Size: 1426
Comment: Last Modified: 03/18/2006 14:06
Location: d:\PB\PBDoc\prod\example\pbdoc_example_ansi.pbl<gf_dosomething.srf>
Author: Review Date: 25/03/2006 14:32:38
Reviewer:   Signed:  
Instance Vars: None Shared Vars: None External: None
Functions: 1 Controls: 0 Events: 0

Local Function Definition
global integer gf_DoSomething ( integer ai_One value, integer ai_Two value, long ai_Three value ) Comments
/********************************************************************
   gf_DoSomething

   <DESC>   This function will accept the three parameters and
            perform some complex mathematics on the variables. The
            mathematics are complex and used from various parts of
            the application. If a problem is encounted in the
            computations then an exception is thrown.</DESC>

   <RETURN> A return code to indicate what happened
            <li> -1 failed
            <li> 1 all ok</RETURN>

   <ACCESS> Public

   <ARGS>   ai_One: Argument one is the first parameter passed to the
            function and is used in the first stage of the
            complex maths.
            ai_Two: Argument two is the second parameter to the
            function and is used in conjunction with the
            first parameter in the maths.
            ai_Three: Argument three is the third and final parameter
            to the function and is used as a factor in the
            calculation performed with ai_one and ai_two.</ARGS>

   <USAGE>   ll_RC = gf_DoSomething( 5, 9, 25 )</USAGE>

********************************************************************/

RETURN 0
 

End of Review Document