Doxygen: extract specific doxygen defines into separate documentaion

Question

I have some source code (STM32 Peripherial Lib) with existing doxygen parameters which my Doxygen Builds without Problems.

For my project I want to generate a document with all functions in each file and a specific information which I want to add to the functions. But I want to keep the old informations for another doxygen configuration.

Is that possible?

I already added this for testing:

\ifnot "SECTION_DEFINE" <normal Doxygen Parameters from original Source Code> \elsif "SECTION_DEFINE" @brief Function Check TODO \endif

With this I could deactivate the existing documentation, but I need to write this \ifnot \elsif \endif to every function. Can I just declare a Tag and only generate the documentation for this specific tag?

Kind regards Andi

Answer 1

You may create a "related page" where only your additional information will be displayed with the \xrefitem command. As \xrefitem will also create a special text section within your original documentation you may want to combine it with your original idea of using section labels and conditional documentation. To top this concept off, use aliases in order to make your documentation more readable.

Consider this example code:

/** ST documentation
 * foobar
 * \exclusive for andi's function \endif
 */
void andreas(void);

/** ST documentation
 * foobar
 * \exclusive for beni's function \endif
 */
void benjamin(void);

You may use this alias in your Doxyfile: exclusive=\if SECTION_DEFINE \xrefitem viparea "Exclusive" "VIPs".

As long as SECTION_DEFINE is not defined, the "exclusive" information will not be included in your documentation. As soon as this section is defined, a "related page" (here: viparea.html) is created in your HTML documentation containing your documented items (here: andreas and benjamin) with the exclusive paragraph behind the command. The result: