Wednesday, April 6, 2011

Custom tags with Doxygen

Hi,

I am trying to figure out if there is a way to create a custom tag using Doxygen. I did find the ALIAS config line but that does not do exactly what I need.

Basically in 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.

This possible with Doxygen?

Thanks.

From stackoverflow
  • 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
      
    RishiD : Excellent, I did not see that while looking at the manual. Thanks a bunch.

0 comments:

Post a Comment