Editing documentation generation target options

 

To edit the options of a documentation generation target, simply carry out the following steps:

1.      Select a project in the "Projects" panel.

2.      Select a documentation target in the "Build targets" page of the "Projects Actions" panel.

3.      Click on the  "Edit options” button in the "Project Actions" panel.

 

Objecteering C++ Developer then opens the "Documentation Target Options" window (Figure 68), in which you can specify options for the selected target. To generate documentation, doxygen is used, and so these options are mapped to doxygen options.

 

Figure 68. The "Doxygen Target Options" window

 

In the "Doxygen Target Options" window you can specify the following options:

 

The … option

Is used to specify…

Target Name

The target name. Objecteering C++ Developer does not allow the creation of several targets with the same name.

External Sources

The path to sources additionally processed by doxygen.

Generated Documentation Path

The root output directory for the doxygen html documentation files produced by the target. Doxygen documentation files are produced for UML packages representing namespaces, for UML classes and interfaces manifested by the project.

Custom Doxygen Options

A set of custom doxygen options, which will be used to generate documentation. Objecteering C++ Developer lets you specify default options using Objecteering C++ Developer parameters, as well as adding your own options. Objecteering C++ Developer provides a default set of doxygen options, which produce logical output.