Doxygen document possible parameter values

Question

Currently my C-code function declaration is documented as follows

/** Some fubar function
 *@param[in]    val1    the first input variable
 *@param[in]    val2    the second input variable
 */
void foo (int val1, int val2);

But say the parameters can only except numbers within a certain range, e.g., 0-500

Is it possible to document this other than as part of the parameter description? Maybe so that it shows up separately in the produced documentation?

E.g. in the latex-produced pdf a table would be produced with a cell for the parameter type (int) the direction (in) and the name (var1/var2). There is some way of having another table cell with 0-500?

albert · Accepted Answer · 2019-03-24 13:43:16Z

2

Your best bet may be a table in the detail section. Doxygen supports HTML commands inside the documentation, and the table generated in the PDF looks decent.

/**
 * @brief Some fubar function
 * @param[in]    val1    the first input variable
 * @param[in]    val2    the second input variable
 *
 * <TABLE>
 * <TR><TD>Type</TD><TD>Direction</TD><TD>Name</TD><TD>Value Range</TD></TR>
 * <TR><TD>int</TD><TD>in</TD><TD>val1</TD><TD>0-500</TD></TR>
 * <TR><TD>int</TD><TD>in</TD><TD>val2</TD><TD>1-1000</TD></TR>
 * </TABLE>
 */
 void foo(int val1, int val2) {}

The issue is that it looks very redundant to me. Perhaps limiting the table to parameter name and expected value would look better.

See Doxygen Manual: HTML Commands for the set of HTML supported by doxygen.

edited Mar 24, 2019 at 13:43

albert

9,2003 gold badges24 silver badges42 bronze badges

answered May 15, 2013 at 2:48

Timmie Smith

4432 silver badges10 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

naught101 Over a year ago

Even better: Doxygen includes Markdown Extra's table syntax. Much nicer on the eyes in the code.

Collectives™ on Stack Overflow

Doxygen document possible parameter values

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related