There are several AutoDoc features for overloaded functions:
- Doc-O-Matic automatically combine overloaded functions with the base function by using the Overloaded Function feature.
- Doc-O-Matic create a special folder for overloaded functions by using the Overloaded Functions Folder feature.
To create overloaded function folders- In the Content Manager toolbar, click Overloaded Functions Folders
. There are two ways to supply content for these folder topics. You can:
- Manually add documentation to this folder topic. In this case Doc-O-Matic automatically inserts an Overload List section that can contain summary and declaration source of all overloaded functions or a navigation overview of all functions.
- Select the Always create content for member folders check box, on the AutoDoc
AutoDoc Folder page, to create content for all member folders including overloaded function folders.
- Use the Combine Topic or Combine With Topic Properties in the Editor.
- Select the Automatically combine overloaded functions check box, on the [General Settings]DocumentationTopic Processing page, to automatically combine overloaded functions. This option is turned on by default.
- If Automatically combine overloaded functions is turned on and a topic exists that describes the overloaded function without arguments this topic is used as combined topic. Notice that you have to create a generic topic with the name of the "base" function, if the parameter less overloaded function does not exist.
Applies to: Doc-O-Matic Professional and Doc-O-Matic SRC
|
Copyright (c) 2000-2008 toolsfactory software inc. All rights reserved.
|