The data for procdures and methods will be extracted from comment lines in procdures and methods.
There is also a external source available. Data for properties, objects, classes and files will be defined in the source file.
See description.
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. There is a flag to stop the use of "prefix" style.
The plug in will transform non HTML signs into the HTML. Transformations can be done per PDM project.
A external file may be provided. This need to be a CSV file with the following format:
"sign","HTML"
example:
"©","©"
"ü","ü"
Please note, do not enter signs & and ", they will be transformed by internal code.
The plug in uses some source files (Settings, Pages "Files"). The path to this files may be relative or absolute. Relative path will be searched in the following order:
It is not suggested to use comments with "prefix" stiele, this may give unexpected results.
It's not recommend to use prefixed lines within a tag and vice versa.
Element | Default | Remarks | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Doc section | <pdm> </pdm> |
This is not part of the plug in.
It is used in methods and procedures to marke the parts to use with PDM plug ins.
Data defined in the sourcetable will not need this! This is the "frame" for all other sections. On the prefix version this section will start with "<pdm>" and end with "</pdm>". There is no tag version available. |
||||||||||||
description | descr | Short description, will be enclosed in CSS class "_AB_PDM_Descr" | ||||||||||||
Remarks | remarks |
Extended remarks. Text will be displayed in "*PDM_AB_Body" CSS Class within "*PDM_AB_Remarks" CSS class. |
||||||||||||
Changes | change |
Display of comment of changes. tag Syntax:
The use of this section is controled by an option of the plug in. A special feature is the ability to merge meta data from sourcecode with meta data from source table. |
||||||||||||
Example | example |
Formatable example to the procedure / method. The text will be in the "diamp_pdm_ab_body" CSS class within the "_PDM_AB_Example" CSS class. |
||||||||||||
See also | seealso |
Formatable list of links to procedure / method / classe or files. Syntax: There will be one link for each tag / Prefix. Syntax: [File]:[Class[.Object]n]:[Member] or [File]::Procedure, followed by one Space and the text to display. for each See tag a link will be created. Each See also tag creates a new block. Anything else in See also tag will be ignored. |
||||||||||||
Copyright | copyright |
Formatable coyright text. The text will be in the "_PDM_AB_Body" CSS class within the "_PDM_AB_CopyRight" CSS class. |
||||||||||||
Footer | footer |
A section that will be place on the end of the section (for example after sourcecode). Text will be displayed in "*PDM_AB_Body" CSS class within the "*PDM_AB_Footer" CSS class. |
||||||||||||
Usage of links | appliesto |
Creates a list of all seealso and see tags that point to this method.
Not available in "prefix" version. tag Syntax:
Only the first occurence will be used. |
||||||||||||
Link | pdmlink |
A different record of the source table should be used.
Usefull on repeated methodes. Not available in "prefix" version. tag Syntax:
Links need a source file to work with. Attributes not included will be replaced with the values of the current "object". Included but empty attributes will not be replaced. This will work only if at least one attribut is included. Example: Link for method Init of class myForm from library sample.vcx: |
||||||||||||
The elements below this line may be used within the the elements beyond this line. |
||||||||||||||
Code | code | This tag enables a block of text that is formated as VFP source code. | ||||||||||||
Expression | expr |
This tag enables an inline text that is formated as VFP source code. Attention, those text will be in a <pre> tag. All leading spaces and tabs will be displayed! |
||||||||||||
Not formated | plain |
This is a block of text that will be displayed as text. All non HTML signs will be transformed, line breaks will be kept. |
||||||||||||
xhtml | xhtml |
This tag enables a block that hold html code that will be passed in the page created. The tag will be ignored if the "Just-XHTML" flag is on. |
||||||||||||
See | see |
This tag enables a inline link to a other member like class / procedure etc.
|
||||||||||||
Note | note |
Creates a block "Note".
This block may display a leading picture and special format.
The blocks may be defined via a CSV file. tag Syntax:
This is a CSV file using following format: "ID","CSS Class","Picture","Title of picture" Example: "E","_PDM_AB_nExclamation","_diamp\res\excla.gif","" "I","_PDM_AB_nInformation","_diamp\res\info.gif","This is an information" Picture are relative to the location of the plug in |
||||||||||||
Auto date | autodate |
This tag will be replaced with the date of the timestamp tTimeStamp of the source file
or if there is no record, no such field or the field is empty with current date.
|
||||||||||||
Item | self |
This tag fügt inserts the name of the item described.
PEM > Class > File Form: File:: Class[.Object]n.PEM |
Every text that is not part of a prefixed line or a within the tags described above will be displayed on procedures end using "PDM_AB_Other" CSS class.
*!* <pdm> *!* 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. *!* </pdm> |
*!* </pdm> *!* <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> *!* </pdm> |
*!* <pdm> *!* <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. *!* </pdm> |