You are here: More Information > FAQ
Special Tasks
Technical Reference
> Parsing
Parsing
Comment Parsing
Output
Special Tasks
> Why are symbols listed in the wrong category?
Close
Doc-O-Matic 10
Why are symbols listed in the wrong category?

Assume you declare a variable as follows:

#define INITSTRING "myInitializationString" MyClassName myVariableName(INITSTRING);

Doc-O-Matic is only a syntactical parser, with no semantic applied. Therefore Doc-O-Matic can not identify whether this is a variable declaration or a type declaration. The variable is identified as function and not as variable. 

To avoid this problem override the symbol source declaration that shows up in the documentation using the Syntax Section.

#ifdef _DOC_O_MATIC_ // Some description, Some description, Some description, // Some description, Some description, Some description, // Some description, Some description, Some description, // Some description, Some description, Some description // Syntax: // MyClassName myVariableName("myInitializationString"); MyClassName myVariableName; #else // this is what the compiler sees MyClassName myVariableName("myInitializationString"); #endif

You must ensure that Conditional Parsing is turned on and define _DOC_O_MATIC_ so that Doc-O-Matic ignores the real declaration.

Conditional Defines

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