You are here: Creating Documentation > AutoDoc Features
Close
Doc-O-Matic 10
AutoDoc Features

Writing your source documentation you can use the AutoDoc features. The Doc-O-Matic AutoDoc features provide documentation for specific symbols, symbol overview pages and links words to topic IDs. AutoDoc features include:

  • Combining overloaded functions with their "base" function if the base function is documented and overloaded functions are not.
  • Creating folders for overloaded member functions.
  • Creating folder and member pages.
  • Aliasing typedef structs and putting typedef parts of typedef structs in struct folders.
  • Copying text for a class member from an inherited symbol, if this is available and if there is no description for the class member.
  • Creating summary sections from the first sentence of your documentation. To turn on this feature select automatic sections on the AutoDoc > Section Options > Automatic page.
  • Creating links from words and symbol names to other topics in the documentation.
  • Adding text to undocumented symbols. You can enter text for all symbol types. For details, see Changing Automatic Texts.
  • Adding declaration source and optionally body source to topics. For details, see Code Presentation.
  • Creating navigation pages, navigation sections and class hierarchies. For details, see Navigation Pages and Sections.

In addition, there are several AutoDoc features that support you by creating optional parts of your documentation. You can

C/C++ Options, Topic Processing Options, Automatic Text, AutoDoc Folder, AutoDoc Content, Automatic Sections, Automatic Linking

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