doxygen comment multiple variables at once

c++ c variables doxygen comments
cjh picture cjh · Apr 25, 2011 · Viewed 10.2k times · Source

If I have the following:

/**
 * @brief (x,y,z) points for block
 */
int x, y, z;

It will only generate that documentation for x, is it possible in doxygen to get it to comment all x, y and z with one comment?

EDIT Following the suggestions of envu I now have the following (based off http://www.doxygen.nl/manual/grouping.html#memgroup)

//@{
/** some documentation here */
int x, y, z;
//@}

or

//@{
/**
 * @brief some documentation here
 */
int x, y, z;
//@}

However both of these still only document x. Trying it with different forms I have yet to get the same documentation string to span multiple variables

Answer

Hari Honor picture Hari Honor · Mar 25, 2013

Been banging my head on this one for a while. Turns out you have to set DISTRIBUTE_GROUP_DOC = YES in the configuration.

Related questions

Where do I find the definition of size_t?

I see variables defined with this type but I don't know where it comes from, nor what is its purpose. Why not use int or unsigned int? (What about other "similar" types? Void_t, etc).

Read More
Why use abs() or fabs() instead of conditional negation?

In C/C++, why should one use abs() or fabs() to find the absolute value of a variable without using the following code? int absoluteValue = value < 0 ? -value : value; Does it have something to do with fewer instructions at lower …

Read More
Convert char to int in C and C++

How do I convert a char to an int in C and C++?

Read More