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

Macro

Meaning

$VBDOC-PATH$

Specifies path where VSdocman is installed. It is always without "\" at the end.

$OUTPUT-PATH$

Specifies output directory for generated documentation. It is always without "\" at the end.

$EXTERNAL-FILES-LIST$

List of external files from external files folder.

$EXTERNAL-FILES-PATH$

Specifies directory for external files. It is always without "\" at the end.

$TEMPLATE-PATH$

Specifies template directory currently used. It is always without "\" at the end.

$PROJECT-NAME$

The name of current project.

$PROJECT-NAME-SAFE$

The name of current project. All non-alphanumeric characters are replaced by underscore.

$SOLUTION-NAME$

The name of current solution.

$SOLUTION-NAME-SAFE$

The name of current solution. All non-alphanumeric characters are replaced by underscore.

$HXCOMP-PATH$

Path to hxcomp.exe including the file itself.

$CUSTOM-VAR1$

Any custom text editable from VSdocman's dialog.

$CUSTOM-VAR2$

Any custom text editable from VSdocman's dialog.

$CUSTOM-VAR3$

Any custom text editable from VSdocman's dialog.

$NEXT-ID$

Unique number within whole document.

$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.

$PROPS-LINK-LIST$

List of links pointing to all properties in current member. It can be used only within DOLIST macro. Every link consists of several fields.

$METHODS-LINK-LIST$

List of links pointing to all methods in current member. It can be used only within DOLIST macro. Every link consists of several fields.

$EXTENSION-METHODS-LINK-LIST$

List of links pointing to all extension methods in current member. It can be used only within DOLIST macro. Every link consists of several fields.

$CONSTRUCTORS-LINK-LIST$

List of links pointing to all constructors in current member. It can be used only within DOLIST macro. Every link consists of several fields.

$EVENTS-LINK-LIST$

List of links pointing to all events in current member. It can be used only within DOLIST macro. Every link consists of several fields.

$NAMESPACES-LINK-LIST$

List of links pointing to all namespaces. It can be used only within DOLIST macro. Every link consists of several fields.

$STRUCTURES-LINK-LIST$

List of links pointing to all structures in current member. It can be used only within DOLIST macro. Every link consists of several fields.

$INTERFACES-LINK-LIST$

List of links pointing to all interfaces in current member. It can be used only within DOLIST macro. Every link consists of several fields.

$DELEGATES-LINK-LIST$

List of links pointing to all delegates in current member. It can be used only within DOLIST macro. Every link consists of several fields.

$ENUMS-LINK-LIST$

List of links pointing to all enumerations in current member. It can be used only within DOLIST macro. Every link consists of several fields.

$FORMS-LINK-LIST$

List of links pointing to all forms in current member. It can be used only within DOLIST macro. Every link consists of several fields. It is always empty if List forms under separate category is unchecked in compile options.

$OBJECTS-LINK-LIST$

List of links pointing to all classes in current member. It can be used only within DOLIST macro. Every link consists of several fields. This list doesn't contain forms if List forms under separate category is checked in compile options.

$STDMODULES-LINK-LIST$

List of links pointing to all modules in current member. It can be used only within DOLIST macro. Every link consists of several fields.

$VARS-LINK-LIST$

List of links pointing to all variables in current member. It can be used only within DOLIST macro. Every link consists of several fields.

$CONSTANTS-LINK-LIST$

List of links pointing to all constants in current member. It can be used only within DOLIST macro. Every link consists of several fields.

$SUPERCLASSES-LINK-LIST$

List of links pointing to all superclasses of current member. It can be used only within DOLIST macro. Every link consists of several fields. The classes are not alphabetically sorted. They are ordered according to inheritance relation.

$SUBCLASSES-LINK-LIST$

List of links pointing to all direct subclasses of current member. It can be used only within DOLIST macro. Every link consists of several fields.

$OVERLOAD-LINK-LIST$

List of links pointing to all overloaded members of current member including current member. 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.

$CUSTOM-TOPICS-LINK-LIST$

List of links pointing to all custom subtopics in current topic. It can be used only within DOLIST macro. Every link consists of several fields.

$TYPE-PARAM-LIST$

List of type parameters descriptions for generics. It can be used only within DOLIST macro. Every list item 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.

$EXCEPTIONS-LIST$

List of exceptions 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 (including parameters if any).

$MEMBER-PURE-NAME$

Name of currently processed member (without parameters if any).

$MEMBER-FULLNAME$

Full name of currently processed member (including parameters if any).

$MEMBER-NAME-NOPARAMS$

Name of currently processed member without parameters.

$MEMBER-NAMESPACE$

Namespace of currently processed member.

$MEMBER-ASSEMBLY-NAME$

Assembly name of currently processed member.

$MEMBER-ASSEMBLY-VERSION$

Assembly version of currently processed member.

$MEMBER-LINK$

Link of of currently processed member.

$MEMBER-TYPE$

Type of currently processed member, e.g. class, method, ...

$MEMBER-EXAMPLE$

Example for currently processed member.

$MEMBER-PARENT$

Parent 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.

$USER-TAGS-LIST$

A list of user-defined tags and their values for current member. The list has the same number of items as number of user tags defined in options. The $LIST-ITEM-LABEL$ field is used for user section heading and $LIST-ITEM-COMMENT$ stores its contents. If the user tag is not used in current member, the $LIST-ITEM-COMMENT$ field is empty.

$MEMBER-NEEDS-PARENT$

Flag indicating whether member needs also parent name to fully identify. If so, its value is "1", empty string otherwise. It is used to distinguish e.g. two various variables of various classes with the same name: variable (Class1) and variable (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 of currently processed member in VB syntax.

$MEMBER-CSHARP-DECLARATION$

Declaration of currently processed member in C# syntax.

$MEMBER-CPP-DECLARATION$

Declaration of currently processed member in C++ with managed extensions syntax.

$MEMBER-CPP2-DECLARATION$

Declaration of currently processed member in pure C++ (.NET 2.0 version) syntax.

$MEMBER-JSCRIPT-DECLARATION$

Declaration of currently processed member in JScript syntax.

$MEMBER-ACCESS$

Accessibility of currently processed member, e.g. Public, Private, ....

$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 "".

$MEMBER-PROTECTED$

Returns "Protected" if currently processed member is friend, otherwise "".

$MEMBER-PROTECTED-FRIEND$

Returns "Protected Friend" if currently processed member is friend, otherwise "".

$MEMBER-OBSOLETE$

Returns value of Obsolete attribute of the member or empty string if Obsolete attribute is not defined.

$MEMBER-FLAGS-ATTRIBUTE$

Returns non-emty string if Flags attribute is specified on enumeration.

$TOPIC-FOOTER$

Topic footer text.

$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.

$SUPPORTED-PLATFORMS$

Text shown in Platforms section.

$SUPPORTED-NET-FRAMEWORK$

Comma delimited supported .NET Framework versions.

$SUPPORTED-NET-CF$

Comma delimited supported .NET Compact Framework versions.

$SUPPORTED-XNA-FRAMEWORK$

Comma delimited supported XNA Framework versions.

$COMPILING-SOLUTION-TO-SINGLE$

Returns non-empty string if we are compiling solution to single documentation.

$MEMBER-IS-VB$

Returns "VB .NET" if member is written in VB, empty string otherwise.

$MEMBER-IS-CSHARP$

Returns "C#" if member is written in C#, empty string otherwise.

$HELP-TITLE$

The documentation title defined in output options.

$DEFAULT-TOPIC-LINK$

A link to the default topic.

$MEMBER-CREF$

A cref value of link of currently processed member.

$MEMBER-PARENT-CREF$

A cref value of link of currently processed member's parent.

$MEMBER-IS-OPERATOR$

Returns non-empty string if member is operator, empty string otherwise.

$MEMBER-CREF-NOPREFIX-NOPARAMS$

A cref value of link of currently processed member but without prefix and parameters.

$MEMBER-OVERLOADS-DESCRIPTION$

Overloads summary of currently processed member.

$MEMBER-OVERLOADS-REMARKS$

Overloads remarks of currently processed member.

$MEMBER-OVERLOADS-EXAMPLE$

Overloads example of currently processed member.

 

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".

$LIST-ITEM-COMMENT$

Usually comment about inherited item. Also used for contents of user tags.

$LIST-ITEM-TYPE$

Usually item type e.g. Class, Method, ...

$LIST-ITEM-SUMMARY$

Summary of target member.

$LIST-ITEM-OVERLOADS-SUMMARY$

Overloads summary of target member.

 

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

Macro

Meaning

$LIST-ITEM$

Name of referenced member.

$LIST-ITEM-FULLNAME$

Full name of item.

$LIST-ITEM-LOCATION$

Module of referenced member.

$LIST-ITEM-FILE$

Filename if item is file reference, empty otherwise.

$LIST-ITEM-CREF$

A cref value of link of referenced member.

$LIST-ITEM-HELPID$

Context help ID of referenced member.

$LIST-ITEM-OBSOLETE$

Returns value of Obsolete attribute of referenced member or empty string if Obsolete attribute is not defined.

$LIST-ITEM-MSDN-A-KEYWORD$

MSDN A-keyword for referenced member.

$LIST-ITEM-MSDN-WEB-FILENAME$

File name of the topic in web MSDN for referenced member.

$LIST-ITEM-SIMPLE-VBDECLARATION$

One line Visual Basic declaration of referenced member. Used e.g. in overloads list.

$LIST-ITEM-SIMPLE-CSHARPDECLARATION$

One line C# declaration of referenced member. Used e.g. in overloads list.

$LIST-ITEM-SIMPLE-CPPDECLARATION$

One line C++ with managed extensions declaration of referenced member. Used e.g. in overloads list.

$LIST-ITEM-SIMPLE-JSCRIPTDECLARATION$

One line JScript declaration of referenced member. Used e.g. in overloads list.

$LIST-ITEM-SIMPLE-CPP2DECLARATION$

One line pure C++ (.NET 2.0 version) declaration of referenced member. Used e.g. in overloads list.

$LIST-ITEM-PUBLIC$

Non-empty string if referenced member is public.

$LIST-ITEM-PRIVATE$

Non-empty string if referenced member is private.

$LIST-ITEM-FRIEND$

Non-empty string if referenced member is friend in VB (internal in C#).

$LIST-ITEM-PROTECTED-FRIEND$

Non-empty string if referenced member is protected friend in VB (internal protected in C#).

$LIST-ITEM-PROTECTED$

Non-empty string if referenced member is protected.

$LIST-ITEM-STATIC$

Non-empty string if referenced member is shared in VB (static in C#).

$LIST-ITEM-SUPPORTS-NETCF$

Non-empty string if referenced member is supported by .NET Compact Framework.

$LIST-ITEM-IS-OPERATOR$

Non-empty string if referenced member is operator, empty string otherwise.

 

The fields that have meaning only with $PARAM-LIST$, $TYPE-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