Builder - Document Tags

Document tags have been used to store process-specific information in the source files. This allows control information for contributed tools (and other processes) to be included in the source files.

This information can then be more easily integrated with source control tools.

The document tags can be mixed case; the process that uses the tags must be able to handle the tags in any case and even mixed case.

Document tags


Document Tags - Build Process

The document tags used by the build process are placed near the beginning of the program and are used to automatically update the build properties for the file during the build process. When modifications are made to the properties, these tags are updated with the new information.

The document tags used by the build process are:

@Author
The original author of the program. This can be a system login code or a full name. There is no corresponding property for this tag - it is for documentation only.
@Date
The creation date of the program. There is no corresponding property for this tag - it is for documentation only.
@Flags
Package flags to be assigned to the program during the build process. This option is restricted for use by registered developers.
@ForceLineNumbers
This option will force line numbers to be used when building the program. The allowed values are "true" or "false".
@LineNumberInc
The line number increment to be used when this source file is compiled. This will override the builder options preference page settings.
@OutputFile
The name to be used for the tokenized program.
@Owner
The owner code to be assigned to the program during the build process. This option is restricted for use by registered developers.
@Password
The password to be assigned to the program during the build process.

Document Tags - Contributed Tools

Other document tags can be placed anywhere in the source file - see the documentation for the specific contributed tool using the document tags for additional information.

The ProvideX Docs contributed tool is one contributed tool that used document tags for context information used by the documentation process.


Next Section: Output Folder Properties