You are here: More Information > Special Tasks
Special Tasks
Technical Reference
> Documenting without Editor > Topic Structure
Close
Doc-O-Matic 10
Starter String Examples

Section Starters are strings, which identify the beginning of a section within comment blocks. Every section can have one or more single line starter strings, which can consist of any character sequence (including white spaces). 

For example, the starter strings for the function parameter description section are by default (without the quotes)

"Parameters", "Arguments", "Inputs", "Input"

In the default configuration both starter strings Summary and Brief map to the same section. The following two examples produce the same documentation:

// Summary: // Foo makes the live easier. int foo(int x, int y); // Brief: // Foo makes the live easier. int foo(int x, int y)

The colon ":" is optional in the cases above, because the starter strings are located on a separate line. If you do not enter starter strings on a separate line, you need to add a special character (section delimiter characters) (by default either ":", "*" or "-") right behind the starter string.

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