Using XMLDoc

XMLDoc is a documentation standard that is used in C#. If you document your source code using XMLDoc tags, it is very easy to adjust Doc-O-Matic. For details, see Adjusting Doc-O-Matic.

XMLDoc tags

XMLDoc tags are used to structure and to format comments. There are some tags that provide commonly used functionality in user documentation. If the XML support is turned on Doc-O-Matic supports most commonly used XMLDoc tags. Most of the tags are interpreted as Doc-O-Matic sections. Handling XMLDoc Tags describes how Doc-O-Matic maps XMLDoc tags to sections and styles.

To insert XMLDoc

Doc-O-Matic can insert XMLDoc tags in your source code, when you enter comments in the Editor.
The setting Documentation Standard determines which standard is used to enter comments in your source code.
Using the XMLDoc standard Doc-O-Matic transforms your comments into text and standard XMLDoc tags.
When you use sections be sure to enter the XMLDoc tag you want to be inserted as section starter as first starter in XMLDoc in the Edit Section dialog.
For more information about how Doc-O-Matic enters comments in your source code, see Inserting Comments. XMLDoc tags can only be inserted into natively supported language files and not in DTX files.

Applies to: Doc-O-Matic Professional.