They must be defined by user because VSdocman uses their values during compilation.

Macro

Meaning

$SPLIT$

Flag indicating whether all members have its own file. If set to "0", then everything will be in one file, if "1" then every part of documentation has its own file.

$MEMBER-EXT$

File extension of member file.

$INDEX-EXT$

File extension of index file.

$CONTENTS-EXT$

File extension of contents file.

$PROJECT-EXT$

File extension of documentation project file.

$vbdoc-description$

A description of current template which is shown in VSdocman dialog.

$vbdoc-constructor-body$

Definition of constructor documentation.

$vbdoc-method-body$

Definition of method documentation.

$vbdoc-property-body$

Definition of property documentation.

$vbdoc-event-body$

Definition of event documentation.

$vbdoc-variable-body$

Definition of variable documentation.

$vbdoc-constant-body$

Definition of constant documentation.

$vbdoc-object-body$

Definition of object (class) documentation.

$vbdoc-stdmodule-body$

Definition of module documentation.

$vbdoc-form-body$

Definition of form documentation.

$vbdoc-delegate-body$

Definition of delegate documentation.

$vbdoc-enumeration-body$

Definition of enum documentation.

$vbdoc-interface-body$

Definition of interface documentation.

$vbdoc-namespace-body$

Definition of namespace documentation.

$vbdoc-structure-body$

Definition of structure documentation.

$vbdoc-index-body$

Definition of index.

$vbdoc-contents-body$

Definition of contents.

$vbdoc-project-body$

Definition of documentation project.

$vbdoc-group-project-body$

Definition of documentation project for whole solution.

$vbdoc-group-contents-body$

Definition of contents for whole solution.

$vbdoc-exec-after$

MS DOS commands which are to be executed after compilation has been done. This is useful to define some additional operations such as files renaming, copying or executing some external application.

$vbdoc-help-file$

Name of the resulting help file.

$EOL$

End of line sequence for given documentation format.

$C$ and $END-C$

Start and end of inline code expression for given documentation format.

$CODE$ and $END-CODE$

Start and end of source code block for given documentation format.

$IMG$ and $GMI$

Inline image.

$REPLACE-TABLE$

Table of strings to be replaced. It is sequence of strings delimited by space. First string will be replaced by second, third by fourth and so on. If you need to have space in some of these strings, use $CHR32$. This macro need not to be defined.

All text (not defined in template file) which is between $REPLACE-ON$ and $REPLACE-OFF$ macros will be replaced. It is useful for implementing escape characters, e.g. "&lt" for "<" in HTML templates.

$CHAR-ENCODING$

Encoding used for output. Supported values are:

UTF-8...used in HTML and XML based output formats

DEFAULT...Default OS encoding. Chars are just copied without modification.

$TYPE-CLASS$

Type name for Class type member. Used as a value of $LIST-ITEM-TYPE$ macro and in the index entries. Useful for translating the templates.

$TYPE-MODULE$

Type name for Module type member. Used as a value of $LIST-ITEM-TYPE$ macro and in the index entries. Useful for translating the templates.

$TYPE-EVENT$

Type name for Event type member. Used as a value of $LIST-ITEM-TYPE$ macro and in the index entries. Useful for translating the templates.

$TYPE-PROPERTY$

Type name for Property type member. Used as a value of $LIST-ITEM-TYPE$ macro and in the index entries. Useful for translating the templates.

$TYPE-VARIABLE$

Type name for Variable type member. Used as a value of $LIST-ITEM-TYPE$ macro and in the index entries. Useful for translating the templates.

$TYPE-CONSTANT$

Type name for Constant type member. Used as a value of $LIST-ITEM-TYPE$ macro and in the index entries. Useful for translating the templates.

$TYPE-METHOD$

Type name for Method type member. Used as a value of $LIST-ITEM-TYPE$ macro and in the index entries. Useful for translating the templates.

$TYPE-DELEGATE$

Type name for Delegate type member. Used as a value of $LIST-ITEM-TYPE$ macro and in the index entries. Useful for translating the templates.

$TYPE-ENUMERATION$

Type name for Enumeration type member. Used as a value of $LIST-ITEM-TYPE$ macro and in the index entries. Useful for translating the templates.

$TYPE-INTERFACE$

Type name for Interface type member. Used as a value of $LIST-ITEM-TYPE$ macro and in the index entries. Useful for translating the templates.

$TYPE-STRUCTURE$

Type name for Structure type member. Used as a value of $LIST-ITEM-TYPE$ macro and in the index entries. Useful for translating the templates.

$TYPE-NAMESPACE$

Type name for Namespace type member. Used as a value of $LIST-ITEM-TYPE$ macro and in the index entries. Useful for translating the templates.

$TYPE-CONSTRUCTOR$

Type name for Constructor type member. Used as a value of $LIST-ITEM-TYPE$ macro and in the index entries. Useful for translating the templates.

See Also