Doc-O-Matic
 
Doc-O-Matic 6
PreviousUpNext
Inherited Descriptions
Related Settings

Topic Processing Options, Namespace Handling

With the AutoDoc feature for inherited description you can automatically copy documentation for class members from inherited symbols. This also works with descriptions in other namespaces, by using the Doc-O-Matic's Namespace features on the [General Settings]Source ParsingNamespaces and the [General Settings]DocumentationTopic Processing page. In this case the time required to process topics might be increased. 

Assume you have the Base::Func function in the Base base class, which is documented, and you override the function as Derived::Func. If you do not write comments for Derived::Func, Doc-O-Matic copies the comment from Base::Func to this function.

Note: Doc-O-Matic copies comments not only for the direct successor but all undocumented successors. If there are multiple inherited descriptions available, the nearest in the hierarchy will be copied.

Applies to: Doc-O-Matic Professional and Doc-O-Matic SRC

Copyright (c) 2000-2008 toolsfactory software inc. All rights reserved.