Browsing documentation for a model element

Introduction

With Objecteering C++ Developer, you can to conveniently browse doxygen documentation for particular model elements in just one click.

To browse documentation, simply select a model element and click on the "Browse documentation" button in the "C++" tab of the auxiliary window.

Figure 72. The "Browse documentation" button in the "C++" tab of the auxiliary window

Objecteering C++ Developer lets you directly browse documentation for classes, interfaces and namespace producing packages. For attributes, operations, parameters and other structural features, Objecteering C++ Developer presents the documentation of the owner class.

If the C++ code or doxygen documentation for the selected model element is not generated, Objecteering C++ Developer proposes to generate it (Figure 73).

Figure 73. Objecteering C++ Developer proposes to generate doxygen documentation

Objecteering C++ Developer then opens the documentation browser using the argument providing the hyperlink to the doxygen HTML file of the model element, or its owner class for structural features, typedefs, enumerations and parameters (Figure 74).

Figure 74. The documentation browser is then opened

Specifying a documentation browser

You can specify the documentation browser you want to use in the "Documentation browser" parameter in the "Doxygen documentation" set of Objecteering C++ Developer parameters.

The documentation browser parameter can be any string including the browser executable filename, and can include the "$docFile" macro. Objecteering C++ Developer substitutes this macro by the hyperlink to the doxygen HTML file, and spawns a process with the obtained string as the command line.

Doxygen link format

The default doxygen link format is "$type$FullCxxName.html", where:

· the "$type" macro is substituted by the standard doxygen "namespace", "class" and "struct" prefixes

· the "$FullCxxName" macro is substituted by the fully qualified C++ name of the model element

· the standard "::" separator is substituted by the doxygen separator. This doxygen separator is specified in the "Doxygen hyperlink format separator" Objecteering C++ Developer parameter. By default, the value of the separator parameter is "_1_1".

You can also specify the custom J function, which translates the name of a model element to the respective doxygen link. This function is defined by the "Doxygen hyperlink construction function" parameter.

If you exploit a custom doxygen distribution, you can adapt Objecteering C++ Developer to a "non-standard" doxygen hyperlink format.