Text Variables

How to get here: In Settings on the corresponding configuration tab, select AutoDoc > Variables

Default Setting

Predefined variables

PROJECTTITLE: The title of the project.
PROJECTSUMMARY: The summary of the project.
COPYRIGHT: The copyright information of the project.
AUTHOREMAIL: The author's e-mail address.
PROJECTVERSION: The version information of the project.
DATE: The current date in short format.
DATEL: The current date in long format.
TIME: The current time in short format.
TIMEL: The current time in long format.
USER: The current user name.
MACHINE: The computer's name.
FILENAME: The name and absolute path of the file a symbol is contained in.
LINENUMBER: The number of the line in which the symbol is located in the source file.
PAR0, PAR1, PAR2, PAR3: Expands to the name of the n-th parameter, if the topic describes a function.
SYMBOLNAME: Expands to the symbol's fully qualified name if the topic is a symbol.
CLASSNAME: Expands to the containing class name, if the topic is a member or class.
MEMBERNAME: Expands to the symbol's simple member name (without class) if the topic is a member.
NAMESPACE: Expands to the namespace of the symbol.

You can also use predefined variables, to create your own variables.

To insert a variable in your documentation

Switch to the Editor.
Enter the variable name enclosed by percentage signs:

%USER%

In the Value box, type a value for your variable.
To apply character formatting to your variable in all configurations, under Format, click .
The variable is added to the Variable list in the Editor and to all configurations.

Notes

Note that variables are not resolved recursively. Doc-O-Matic resolves variables in normal text only, but not in <code> and <pre> sections or paragraphs formatted preformat and code.

Terms

variable A placeholder for a value that is defined elsewhere.