| Object: | nc_helperfunctions | Size: | 3395 |
| Comment: | A collection of helper functions which demonstrate how to document a custom non visual class V3.0.0 | Last Modified: | 03/08/2006 20:26 |
| Location: | d:\PB\PBDoc\prod\example\pbdoc_example_ansi.pbl<nc_helperfunctions.sru> |
| Author: | Review Date: | 25/03/2006 14:32:38 | |
| Reviewer: | Signed: |
| Instance Vars: | None | Shared Vars: | Included | External: | Included |
| Functions: | 2 | Controls: | 0 | Events: | 1 |
| Shared Variable Definition | Comments |
Integer si_SharedCounter |
| External Function Definition | Comments |
protected: Function long LoadCursorA( long al_happ, long al_hind ) library 'user32' Function long SetCursor( long al_hcur ) library 'user32' Function boolean DestroyCursor( long al_hcur ) library 'user32' |
| public integer AddItem ( string as_Name value, string as_value value ) | Comments |
/********************************************************************
AddItem
<DESC> Add an item to the pretend collection. This method shows
documentation for aguments and return values.</DESC>
<RETURN> integer:
sucess of the addition
<li> -1, failed to be added
<li> 1, added ok</RETURN>
<ACCESS> Public
<ARGS> as_Name: Name of the item to be added.
as_value: Value related to the named being added.</ARGS>
<USAGE> li_RC = myHelper( 'Test', 'Value' )</USAGE>
********************************************************************/
RETURN 1
|
| public integer AddControl ( uo_cb acb_Item value ) | Comments |
/********************************************************************
AddControl
<DESC> This function adds a fictious control object to the
collection. This method shows how parameters of type of
classes within the application will be referenced and
automatically hyperlinked. It also shows that custom
exceptions are reported and hyerlinked if they are
defined within the application being documented</DESC>
<RETURN> integer:
return if the control was added to the collection:
<li> -1, control could not be added
<li> 1, control was added sucessfully</RETURN>
<ACCESS> Public
<ARGS> acb_Item: The control to be added to the collection.</ARGS>
<USAGE> ll_RC = myHelper.AddControl( uo_1 )</USAGE>
********************************************************************/
RETURN -1
|