|
GenHelp Examples
GenHelp understands how programmers document their code and uses
this to simplify production of help
files. |
| GenHelpPro can generate Web sites documenting your code that look like the MSDN Web site or PasDoc html output.
|
|
|
Take the following example of a pascal class: |
//---------------------------------------------------------------------
//
Parameters: Check: This is a comment for the String Check
// and
yet more comment.
// Return: Boolean comment for return
value
// and yet more comments for return value
function Fred.Func(Check: string):
Boolean;
begin
end;
|
| GenHelp will create a Pascal Help topic like this: |
 |
| Or this example in C++ |
/*-----------------------------------------------------------------------------
*
Overview: Initialise a new binary search tree
* params: List:
pointer to list to be initialised
* Flags: any (boolean) flags
required
* BalanceChanges: Number of changes to the list before
it's
* re-balanced. If 0, the list is never balanced
* return:
None
* Description:
* MUST be called for each new tree that's
created
-----------------------------------------------------------------------------*/
void
initBST(BSTlist *List, UINT32 Flags, bool
BalanceChanges, int
NodeSize)
{
}
|
| GenHelp will create a C++ Help topic like this: |
 | |
