Section Delimiters

How to get here: In Settings on the General Settings tab, select [General Settings] > Sections > Delimiters.

Default Setting

When processing a topic Doc-O-Matic tries to detect section Starters and section text. Starters must either be placed in a sperate line above section text or a section delimiter must be inserted between Starters and section text. When Doc-O-Matic inserts comments into your source code, it starts a new line for the section text so that section delimiters are not necessary.

To always insert section delimiters

Select [General Settings] > Editor > Comments.
Select the Always add section delimiters check box.

Notes

If you allow spaces as section delimiter and you enter the word parameter as first word in a comment line it will be recognized as section starter for your parameter section. You can avoid this problem by using the "\" character to escape the word parameter in your source code.

Terms

sections Logical areas topics and comment blocks can be divided into.

starters Characters that indicate that a new section starts in Doc-O-Matic.

section delimiters Characters that separate section text from section starters.