Embedded Wizard Studio: Extract documentation dialog

With this dialog you can automatically generate documentation containing an overview of your project structure and detailed description of all included members. This dialog appears when activating the command Extract documentation ... and permits you to choose the options to control the documentation generation:

Extract documentation dialog

Include Units

The upper part of the dialog contains a list of all units belonging to the current project. You can determine for each unit individually whether it should be involved in the document generation or not. Members of units not included are consequently not listed in the resulting document. For example, if you are developing a component framework and you want to extract documentation for this framework only, you can select only these units, which in fact do contain the implementation of the framework.

To include or exclude a unit, click with the mouse on the small check box found left of the name of the unit.

To include all available units click on the button Select all.

To exclude all units click on the button Deselect all.

Include 'Class Overview' diagram

Class overview is a section in the generated document showing the inheritance tree of classes found within the included units. This section appears at the beginning of the document providing a general summary of the project structure:

Example of a class overview section in the generated documentation.

To include or exclude the class overview section, click with the mouse on the check box Include 'Class overview' diagram.

Include 'Languages and Styles' topic

The generated document can contain a section describing all language and style members found in the project. This section appears usually at the end of the resulting document:

Example of a languages and styles section in the generated documentation.

To include or exclude the section, click with the mouse on the check box Include 'Languages and Styles' topic.

Include 'Profiles and Macros' topic

The generated document can contain a section describing all profile and macro members found in the project. This section appears usually at the end of the resulting document:

Example of profiles and macros section in the generated documentation.

To include or exclude the section, click with the mouse on the check box Include 'Profiles and macros' topic.

Exclude unit and class members without description

The documentation generation can be configured to ignore project members not having any text in their Description attribute. In such case the affected members are not listed in the resulting document.

To ignore all undocumented members, enable with the mouse the check box Exclude unit and class members without description.

To include the members regardless of the available description, disable the check box.

Exclude all onget/onset methods

The documentation generation can be configured to ignore all onget and onset methods. This usually makes sense because these methods are not directly accessible. In fact, the actual interface is represented only by the property the affected method is associated to.

To ignore all onget/onset methods, enable with the mouse the check box Exclude all onget/onset methods.

To include these methods, disable the check box.

Include additional introduction topic file

The documentation generation can be configured to include into the resulting document one additional leading section with an arbitrary content. This, for example, can be the introduction for the documentation or copyright notes, etc. The content for this additional section has to be provided within a single valid HTML file.

You can develop the HTML file with your favorite HTML authoring tool or simply code it with a text editor. Anyway, please take in account, that the entire content including CSS or JavaScript is stored within a single HTML file. No references to other files are possible.

Store the HTML file within the directory of your project.

Enter the name of the corresponding HTML file in the upper edit field.

Specify the document title

You can edit the title of the resulting document. The title appears in the caption bar of the window when the document is opened:

Title shown in the resulting document.

To specify the title enter it in the middle edit field.

Specify the destination directory

You can specify the directory where Embedded Wizard should put the resulting document. The documents are stored in the Microsoft specific format CHM (compiled help module) and can be viewed with the Microsoft HTML Help Control application (Help Viewer).

To specify the directory enter it in the bottom edit field.

Please note, that if the entered path is not absolute, it will be evaluated relative to the project directory.

Extract

The documentation generation is started by pressing the button Extract. This process may take between few seconds and several minutes. At the end of the generation process, the Microsoft HTML Help Control application (Help Viewer)‚ is started presenting the resulting document. Please note the messages reported within the Log window.