Doxygen:是否可以对C++函数参数进行分组,即具有相同的文档而不重复它？

Question

是否可以在Doxygen文档中对函数参数进行分组,以便我不必复制注释？例如,我想要类似的东西:

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

氧气输出:

<...>
Parameters:

  a,b - <long documentation>

Answer 1

是的,你可以用@param传递逗号分隔的参数列表,如下所示:

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

它会像你期望的那样出现在输出中.