Custom tags with Doxygen

doxygen
RishiD picture RishiD · Feb 11, 2009 · Viewed 22.5k times · Source

I am trying to figure out if there is a way to create a custom tag using Doxygen. I did find the ALIAS configuration file option but that does not do exactly what I need. Basically in my code I want to be able to write something like 

/// \req Requirement #322 - blah blah

And then have Doxygen create a list like it does for \bug and \todo commands for lines that have this custom tag. Is this possible with Doxygen?

Answer

mouviciel picture mouviciel · Feb 11, 2009

The generalization of \bug and \todo is \xrefitem.

The solution I suggest is:

  • in Doxyfile:

    ALIASES += "req=\xrefitem req \"Requirement\" \"Requirements\" "

  • in documented code:

    /// \req #42 - The system shall work in any situation

Related questions

How to document Python code using Doxygen

I like Doxygen to create documentation of C or PHP code. I have an upcoming Python project and I think I remember that Python doesn't have /* .. */ comments, and also has its own self-documentation facility which seems to be the pythonic …

Read More
How to use doxygen to create UML class diagrams from C++ source

I have been searching for some material that describes how to generate simple class diagrams with doxygen, but couldn't find one. Can anybody help? I need to create diagrams as shown below from a set of C++ files. If there …

Read More
How to make an introduction page with Doxygen

I made documentation for my SDK, using Doxygen. It contains the list of files, namespaces, classes, types etc. - everything that I placed as Doxygen comments in the code. Now I want to write some general information about SDK (kind …

Read More