You are here: More Information > FAQ
Special Tasks
Technical Reference
> Comment Parsing
Parsing
Comment Parsing
Output
Special Tasks
> Why are characters not recognized as starters?
Why are characters not recognized as starters?
Close
Doc-O-Matic 10
Why are characters not recognized as starters?

All characters that are set as starter strings for sections are recognized by Doc-O-Matic. If a starter string is not recognized section delimiters might be missing. 

Assume starter strings of a section of the ignored text type are set to the characters #X#. The following comments:

{@@Topic1 Description This is topic1. #X# This text should not be shown. some source code...

result in the documentation text: 

This is topic1.#X# This text should not be shown. 

You can run into problems, if you do not use section delimiters, but place section text and section starter string on the same line. To use spaces as section delimiter, turn on the option Allow spaces as section delimiter on the General Settings > Sections > Section Delimiter page. You can use both methods:

{@@Topic1 Description This is topic1. #X# : This text should not be shown. some source code... {@@Topic1 Description This is topic1. #X# This text should not be shown. some source code...

Both comments result in the documentation: 

This is topic1.

Section Delimiter

Copyright © 2000-2020 toolsfactory software inc. All rights reserved.