DBPowerSuite 7.9 Application Programming Interface
Documentation Generation

Class Description

Get Help Info from Source Code

Class Name

PSFunctionHelp

Parent Class

ULogObject

Header Name

PSFunctionHelp.h

Library

libpsUCommon

Language

C++

Author

Brian N. Ceccarelli

Location

Apex, NC

Date Written

July 7, 2002

Last Updated

August 29, 2002

Last Updated By

Brian N. Ceccarelli

Notes

     This class finds the help for the first function in an array of
text strings.    You supply the pointer to the array of string
pointers, then you call methods of this class which in turn parse
the text strings and give you access to the various sections of the
function's help text.

     You will not know what function's help it's going to get until
after it has read through your string arrays.   Call methods
fhGetClassName and fhGetFunctionName to find out.

     This class finds only the first occurrance of help text in your
string array.    If there is more than 1 function in your string
array, then the class hasn't read that far into the string array.
This class assumes that the help text for the function
either immediately precedes the function body or is inside the
function.  Once the class detects the end of a function, it considers
that it got whatever help comments it's going to get.

     This class also pulls out the class definitions and their
methods.   But again, the class will stop getting the information
once it reaches the end of the first function definition.

     In order for you to pull help from functions further in the
string array, you must set the position of the text array pointer,
and then get the help text again.   You can use fhGetCurrentLine
to get what line the class has stopped at.   Remember, one
PSFunctionHelp object contains the help text for only one function.

     The program that uses this class is psListFunctionsForWeb.

     psListFunctionsForWeb collects a list of class and function
names by using the class PSHeader.   For each class and function
name, psListFunctionsForWeb reads through all the PS source code
using uReadFile() passing uReadFile's array of text strings
to the methods of PSFuntionHelp.  psListFunctionsForWeb organizes
all the returned information from PSFunctionHelp,  then uses
PSWebTable to generate web pages for all classes and functions in
the PS API.