Doxygen: Можно ли сгруппировать параметры функции C ++, т.е. иметь одинаковую документацию, не дублируя ее? - PullRequest
3 голосов
/ 05 февраля 2012

Можно ли сгруппировать параметры функции в документации Doxygen, чтобы мне не пришлось дублировать комментарий?Например, я хочу что-то вроде:

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

Выход кислорода:

<...>
Parameters:

  a,b - <long documentation>

1 Ответ

5 голосов
/ 05 февраля 2012

Да, вы можете просто передать список параметров через запятую с помощью @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)
{
}

И он появится в выводе, как и следовало ожидать.

...