Introduction to documenting an application

With Objecteering C++ Developer, you can conveniently enter documentation for application models. Documentation is produced in doxygen HTML format, which is widely used in the C++ world. This format is convenient for browsing and can be easily converted to other formats, such as CHM.

Objecteering C++ Developer manages the documentation management process as follows:

1. Model elements are documented by decorating them with documentation notes, which can contain doxygen tags.

2. Objecteering C++ Developer injects documentation notes into the produced sources as doxygen comments.

3. Objecteering C++ Developer runs the doxygen binary on the produced sources. doxygen finally produces documentation HTML files.

4. You can browse doxygen documentation for selected model elements.

Documentation generation targets provide the options used to drive doxygen behaviour. Objecteering C++ Developer translates these options into the doxygen command file, which is processed by the doxygen binary.

Note: If you are using Windows, the Windows version of doxygen must be used. Do NOT use the version of doxygen provided by the Cygwin tool.