Doxygen - create a custom team

I think my question is basically the same as this one, but it did not get a good answer: Creates a new user command that will add a section to Doxygen

I really want to do the same, I think. I want to completely duplicate the exact functionality of the @param parameter, except to give it the heading “Parameters” instead of “Parameters”. I want the arguments to be the same (data type, variable name and description) and want them to look the same and that’s it. Literally, the only thing I need is a headline.

I also tried to do this:

 ALIASES = option"\par Options:\n" 

in my Doxyfile, but I also get every single parameter in my own section, and not all of them in one section. They also do not have the same arguments as the @param parameter.

I also tried to do something with \xrefitem , which of course did not work. I tried this:

 ALIASES = option="\xrefitem param \"Option\" \"Options\" " 

but it looks like \xrefitem used to create something more like a compiled list from different sections, like the Todo list.

Help is appreciated. Thanks!


EDIT:

To clarify, the result I'm looking for would look something like this:

Options:
string $ option1 This is option 1.
string $ option2 This is option 2.

+1
command arguments doxygen param
source share
2 answers

The closest I could come up with the following:

 @par Options: @li @e string @b $option1 This is option 1. @li @e string @b $option2 This is option 2. 

This almost works decently, except that it does not align each part nicely, as it does with @param . Therefore, if the first parameter name is something like $option1 , and the second option name is $thisIsTheSecondOption , the beginning of the descriptions will not be aligned. This is more like:

Options:
<string> int $ thisIsTheSecondOption This is option 2.

This makes reading difficult.

: - \

0
source share

I am sure this is not possible without changing doxygen. I would just use \ li and list the insteand options for using \ param.

http://www.stack.nl/~dimitri/doxygen/commands.html#cmdli

0
source share

All Articles