You are here: AutoDoc and Formatting > Customizing AutoDoc Parts > Navigation Pages and Sections
Close
Doc-O-Matic 10
Navigation Pages and Sections

Doc-O-Matic automatically creates cross-references of source code symbols and generic topics. In Help systems you can create cross-references both as navigation sections and as navigation pages.

Topic overviews

Overviews of all subtopics of a topic are created such as members, data members (variables), methods, types and nested classes for classes. Members are listed by their name. In addition, to symbol types folders (Contents Entries) are used as custom categories to sort topics. For example, if you create a folders(Contents Entry) for constructors of the myclass class and add the constructors to the Construction folder (Contents Entry) in the overview all constructors will appear in the Construction navigation section and on the Construction page. For more information about folders Contents Entries, see Contents Entries

Base class members are listed on the navigation pages, by default. For files an overview of all classes, functions, macros, types and variables of a file is created.

Class hierarchy

Doc-O-Matic creates a class hierarchy for each class (Inheritance Hierarchy or Class Hierarchy section). You can create your class hierarchy as graphic or text. In addition, you can include derived classes. For details, see Class Hierarchy Layout.

Legend

On navigation pages and in navigation sections graphics are used to indicate certain properties of the listed elements such as visibilities. Doc-O-Matic creates legends that explain the purpose of these symbols. There are several ways for you to present legends: On navigation pages, on topic pages following each member category or in a separate navigation section and on subpage of navigation pages accessible by links.

Member sections

For members of structures, records or enums Doc-O-Matic creates a Member section. For more information about Member sections, see Parameters, Return Values and Member Sections.

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