Die Daten werden aus Kommentaren in den entsprechenden Methoden oder Prozeduren gewonnen.
Alternativ dazu kann eine Quelldatei angegeben werden. Siehe Beschreibung.
Beachten Sie, daß das "Hauptprogramm" einer Programm Datei wie folgt in der Quelldatei eingetragen werden muß: CLassLoc="Dateiname" class="" Objname="MAIN PROGRAM"
Dieser plug in gestattet die Benutzung des "tag" Stieles für die Dokumentation von Methoden und Prozeduren. Der ursprüngliche "Prefix" Stiel bleibt erhalten. Beide Stiele können gemischt werden.
Dieses Dokument zeigt nur die speziellen Optionen des DIAMP plug ins. Allgemeine Optionen werden in _pdm_ab.html beschrieben.
Element | Standard | Bemerkung | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parameter | params |
In der "prefix" Version wird folgende Syntax verwendet: tag Syntax:
Die komplexe Beschreibung wird im <detail> Element innerhalb des Parameter Elements notiert. In der komplexen Beschreibung können HTML formatierten Text und Links verwendet werden. Parameter werden in zwei Abschnitten angezeigt:
|
|||||||||||||||||||||
Rückgabewert | retval |
In der "Prefix" Version kann der Rückabewert formatiert beschrieben werden. In der "tag" Version kann ein optionales "type" Attribut innerhalb des <return> tags verwendet werden. tag Syntax: |
|||||||||||||||||||||
Verweis auf Parameter | pdmpara |
Erzeugt einen Link zu einem Parameter der aktiven Methode / Prozedur.
Es wird der Namen des Parameters, wie im name Attribut des Parameter tags definiert, angezeigt. 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 |