Read-only macros

Their values are set by VBdocman during compilation and user cannot redefine them. Note, links in all lists are sorted alphabetically.

Macro Meaning
$VBDOC-PATH$ Specifies path where VBdocman is installed. It is always without "\" at the end.
$OUTPUT-PATH$ Specifies output directory for generated documentation. It is always without "\" at the end.
$PROJECT-NAME$ The name of current VB project.
$NEXT-ID$ Unique number within whole document. It could be used as an ID of next activeX object in current file.
$COUNTER$ Value of internal counter.
$SEE-LINK-LIST$ List of See Also links. It can be used only within DOLIST macro. Every link consists of several fields.
$EXAMPLE-LINK-LIST$ List of Examples links. It can be used only within DOLIST macro. Every link consists of several fields.
$PROPS-LINK-LIST$ List of Properties links. It can be used only within DOLIST macro. Every link consists of several fields.
$METHODS-LINK-LIST$ List of Methods links. It can be used only within DOLIST macro. Every link consists of several fields.
$EVENTS-LINK-LIST$ List of Events links. It can be used only within DOLIST macro. Every link consists of several fields.
$APPLIES-LINK-LIST$ List of Applies To links. It can be used only within DOLIST macro. Every link consists of several fields.
$INDEX-LINK-LIST$ List of links pointing to all entries in index. It can be used only within DOLIST macro. Every link consists of several fields.
$CONT-FORMS-LINK-LIST$ List of links pointing to all forms in contents. It can be used only within DOLIST macro. Every link consists of several fields.
$CONT-OBJECTS-LINK-LIST$ List of links pointing to all objects (classes) in contents. It can be used only within DOLIST macro. Every link consists of several fields.
$CONT-STDMODULES-LINK-LIST$ List of links pointing to all standard modules in contents. It can be used only within DOLIST macro. Every link consists of several fields.
$CONT-METHODS-LINK-LIST$ List of links pointing to all methods in contents. It can be used only within DOLIST macro. Every link consists of several fields.
$CONT-FUNCTIONS-LINK-LIST$ List of links pointing to all functions in contents. It can be used only within DOLIST macro. Every link consists of several fields.
$CONT-PROPS-LINK-LIST$ List of links pointing to all properties in contents. It can be used only within DOLIST macro. Every link consists of several fields.
$CONT-EVENTS-LINK-LIST$ List of links pointing to all events in contents. It can be used only within DOLIST macro. Every link consists of several fields.
$CONT-VARS-LINK-LIST$ List of links pointing to all variables in contents. It can be used only within DOLIST macro. Every link consists of several fields.
$CONT-CONSTANTS-LINK-LIST$ List of links pointing to all constants in contents. It can be used only within DOLIST macro. Every link consists of several fields.
$PARAM-LIST$ List of parameters descriptions. It can be used only within DOLIST macro. Every list item consists of several fields.
$SET01-LIST$ List of first parameter settings descriptions. It can be used only within DOLIST macro. Every list item consists of several fields.
$SET02-LIST$ List of second parameter settings descriptions. It can be used only within DOLIST macro. Every list item consists of several fields.
$SET03-LIST$ List of third parameter settings descriptions. It can be used only within DOLIST macro. Every list item consists of several fields.
$MEMBER-NAME$ Name of currently processed member.
$MEMBER-MODULE$ Module name of currently processed member.
$MEMBER-DESCRIPTION$ Description of currently processed member.
$MEMBER-REMARKS$ Remarks of currently processed member.
$MEMBER-RETURN$ Returns field of currently processed member.
$MEMBER-AUTHOR$ Author of currently processed member.
$MEMBER-REVISION$ Revision date of currently processed member.
$MEMBER-VERSION$ Version of currently processed member.
$MEMBER-USER1$ User-defined field 1 (value of user-defined tag 1). Also $MEMBER-usertagname$ can be used instead of $MEMBER-USER1$, where usertagname is a name of the user-defined tag 1. For example, if the name of user tag 1 is @copyright, then macro is $MEMBER-USER1$ or $MEMBER-COPYRIGHT$.
$MEMBER-USER2$ User-defined field 2 (value of user-defined tag 2). Also $MEMBER-usertagname$ can be used, see $MEMBER-USER1$.
$MEMBER-USER3$ User-defined field 3 (value of user-defined tag 3). Also $MEMBER-usertagname$ can be used, see $MEMBER-USER1$.
$MEMBER-USER4$ User-defined field 4 (value of user-defined tag 4). Also $MEMBER-usertagname$ can be used, see $MEMBER-USER1$.
$MEMBER-USER5$ User-defined field 5 (value of user-defined tag 5). Also $MEMBER-usertagname$ can be used, see $MEMBER-USER1$.
$MEMBER-NEEDS-MODULE$ Flag indicating whether member needs also module name to fully identify. If so, its value is "1", empty string otherwise. It is used to distinguish e.g. two various properties of various classes with same name: property (Class1) and property (Class2).
$MEMBER-SOURCECODE$ Source code of currently processed member. New lines are separated by $EOL$ macro. Some processing tools may report warnings because source code can contain statements like this: "If a<> 0 Then", which can be interpreted as empty tag in markup languages.
$MEMBER-DECLARATION$ Declaration line (first source code line) of currently processed member.
$MEMBER-PUBLIC$ Returns "Public" if currently processed member is public, otherwise "".
$MEMBER-PRIVATE$ Returns "Private" if currently processed member is private, otherwise "".
$MEMBER-FRIEND$ Returns "Friend" if currently processed member is friend, otherwise "".

$TITLE-PAGE-TEXT$

Text on title page of generated documentation. This text is without title.

$GROUP-PROJECTS-LIST$ List of project names in the project group.

$CHRn$

Expands to ASCII character specified by n. Allows to add any character (with ASCII code 0-255) into resulting documentation. For example $CHR13$$CHR10$ inserts a new line.

$TEMPLATE-PATH$ Specifies template directory currently used. It is always without "\" at the end.

Fields in lists

Every item in every list contains a set of fields. The field is also the macro. Some of them have not meaning with all the lists.

The fields that have meaning with all lists:

Macro Meaning
$LIST-ITEM-NUMBER$ Order number of current item in list.
$LIST-ITEM-LABEL$ Textual label of current item in list.
$LIST-ITEM-FIRST$ A flag, empty if it is not first item in the list, otherwise "1".
$LIST-ITEM-LAST$ A flag, empty if it is not last item in the list, otherwise "1".

The fields that have meaning only with lists containing some links:

Macro Meaning
$LIST-ITEM$ Name of referenced member.
$LIST-ITEM-LOCATION$ Module of referenced member.
$LIST-ITEM-FILE$ Filename if item is file reference, empty otherwise.
$LIST-ITEM-HELPID$ Context help ID of referenced member.

The fields that have meaning only with $PARAM-LIST$,$SET01-LIST$,$SET02-LIST$ and $SET03-LIST$ lists:

Macro Meaning
$LIST-ITEM-PARAM$ Name of parameter.

The fields that have meaning only with $SET01-LIST$,$SET02-LIST$ and $SET03-LIST$ lists:

Macro Meaning
$LIST-ITEM-CONSTANT$ Name of constant for current setting.
$LIST-ITEM-VALUE$ Value of constant for current setting.

See also VBdocman macro language.


Send feedback to Helixoft
© 2000-2005 Helixoft. All rights reserved.