Section Adjustment

You can divide comments into several logical areas. These parts often begin with headings and are followed by text either in the same line or in the next line. In Doc-O-Matic these areas are called sections. You are not required to identify section headings or starters in a special way when using Doc-O-Matic. You only enter section text on the line beneath section starters or enter a separator between section starters and section text.

To adjust Doc-O-Matic

Make sure XMLDoc support is turned on, if you use XMLDoc and Javadoc support is turned on, if you use Javadoc and \support is turned on if you use \ character as starter for Javadoc tags. Doc-O-Matic recognizes section starters used in XMLDoc and in Javadoc.
Set up new sections for each section that Doc-O-Matic does not recognize.
Enter your own starter strings as starters for predefined sections. To do this, select a section on the [General Settings] > Sections page. In the Edit Section dialog box enter your own starter strings in Starters or enter Javadoc tags in the Javadoc box or XMLDoc tags in the XMLDoc box
Make sure the Section Delimiter you use is recognized, unless your section text starts in a separate line. If you use spaces as section delimiter select the Allow spaces as section delimiters and Allow spaces as delimiters for parameter names check box on the [General Settings] > Sections > Delimiters page.

Advanced User Information

Doc-O-Matic can automatically create a summary section from your comments. For details, see Automatic Sections.

Additional Information

Plain Text Example
Javadoc Example
XMLDoc Example
Doxygen Example

Related Settings

Javadoc, XML, Section Delimiter, Automatic Sections, Sections