Doxygen: Is it possible to group C++ function parameters, i.e. have the same documentation without duplicating it?

Question

Is it possible to group function parameters in Doxygen documentation so that I don't have to duplicate the comment? For example I want something like:

/**
  <...>
  @param {{a, b}} <long documentation>
*/

Doxygen output:

<...>
Parameters:

  a,b - <long documentation>

doxygen · Accepted Answer · 2012-02-05 13:08:31Z

6

Yes, you can just pass a comma separated list of parameters with @param, like so:

/** Sets the object's position.
 *  @param x,y,z Coordinates of the position in 3D space.
 */
void setPosition(double x,double y,double z)
{
}

And it will appear in the output as you would expect.

answered Feb 5, 2012 at 13:08

doxygen

15k2 gold badges45 silver badges40 bronze badges

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

Collectives™ on Stack Overflow

Doxygen: Is it possible to group C++ function parameters, i.e. have the same documentation without duplicating it?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related