The data will be extracted from comment lines in procdures and methods. There is also a external source available. See description. Please note that the "main program" of a program fileneed to be declared as followed in external source table: CLassLoc="filename" class="" Objname="MAIN PROGRAM"
This plug in enables the use of "tag" style documention for methods and procedures. The "prefix" style documentation will be kept. Both styles may be mixed.
This file lists special options of this plug in. Common options will be at _pdm_ab.html.
Element | Default | Remarks | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parameters | params |
On the "prefix" version the description of a parameter will be like: tag Syntax:
Detail description will be in <detail> element within the parameters element. Detail descriptionen uses formated text with links. Parameters will be displayed in two sections.
|
|||||||||||||||||||||
Return value | retval |
On the "prefix" version there will be a formatable description of the return value. On the "tag" version an optional "type" attribut will be available in the <return> tag. tag Syntax: |
|||||||||||||||||||||
Link to a parameter | pdmpara |
Creates a link to a parameter of the current method / procedure.
The parameter will be displayed as defined in the name attribut of the Parameter tag. tag Syntax:
</span> |
*!* DOC_START *!* DESCR This function emulates VFP <expr>STREXTRACT</expr> for versions below VFP 7.0 *!* DESCR The function will be disabled in Version 7 and beyond using #IF *!* Example <code> *!* Example TEXT lcText NOSHOW *!* Example <short>Specify the type of controls <i>placed<i> on the search.</short> *!* Example ENDTEXT *!* Example lcExmaple = STREXTRACT(lcText,"<i>","</i>") &&returns placed *!* Example </code> *!* PARAMS tcSearchExpression ByVal IN Character Specifies the string to search. *!* DOC_END |
*!* DOC_START *!* <descr> *!* This function emulates VFP <expr>STREXTRACT</expr> for versions below VFP 7.0 *!* The function will be disabled in Version 7 and beyond using #IF *!* </descr> *!* <example><code> *!* TEXT lcText NOSHOW *!* <short>Specify the type of controls <i>placed<i> on the search.</short> *!* ENDTEXT *!* lcExmaple = STREXTRACT(lcText,"<i>","</i>") &&returns placed *!* </code> *!* </example> *!* <params name="tcSearchExpression" direction="IN" type="Character"> *!* <short>Specifies the string to search.</short> *!* </params> *!* DOC_END |
*!* DOC_START *!* <descr> *!* This function emulates VFP <expr>STREXTRACT</expr> for versions below VFP 7.0</descr> *!* DESCR The function will be disabled in Version 7 and beyond using #IF *!* <example><code> *!* TEXT lcText NOSHOW *!* <short>Specify the type of controls <i>placed<i> on the search.</short> *!* ENDTEXT *!* lcExmaple = STREXTRACT(lcText,"<i>","</i>") &&returns placed *!* </code></example> *!* PARAMS tcSearchExpression ByVal IN Character Specifies the string to search. *!* DOC_END |