doxygen комментирует сразу несколько переменных

Если у меня есть следующие:

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

он будет генерировать только эту документацию для x, возможно ли в doxygen заставить ее комментировать все x, y и z с одним комментарием?

изменить Следуя предложениям envu, теперь у меня есть следующее (на основе off http://www.stack.nl / ~Дмитрий / доксиген / группировка.html#memgroup)

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

или

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

однако оба они по-прежнему только документ x. Пробовать его с различными формами I еще нужно получить ту же строку документации, чтобы охватить несколько переменных

13
c c++ comments doxygen variables

4 ответов

Я хотел бы использовать группы членов http://www.stack.nl / ~Дмитрий / доксиген / группировка.html#memgroup для этого. Синтаксис и вывод немного отличаются от того, что вы хотите достичь, но я думаю, что это не должно повредить.

11

стучал головой об этом некоторое время. Оказывается, вы должны установить DISTRIBUTE_GROUP_DOC = YES в конфигурации.

22

Я понимаю, что это старый вопрос, но у меня была подобная проблема и нашли решение, которое не решит проблему, но может быть приемлемой заменой в некоторых случаях.

поместив комментарий над блоком группы членов и добавив к нему префикс \name декоратор, вы получаете описание, которое отображается выше всех переменных в группе членов в списке атрибутов страницы Doxygen. Я считаю, что это должно быть краткое описание, но вы можете поместить здесь произвольно длинные описания, если хотите.

это не имеет эффекта размещения одних и тех же комментариев в поле detail для каждой из переменных в группе членов (поля detail будут пустыми, или если вы поместите комментарий внутри блока группы членов, он все равно будет применяться только к первой переменной), но это имеет эффект документирования связанной группы переменных вместе, что похоже на первоначальное намерение вопроса было.

пример:

/*! \name This will be the description for the following group of variables
          It can be arbitrarily long, but the first line will show up in bold,
          and any subsequent lines will show up like a description under it
*/
//@{
int relatedVariable1;
int relatedVariable2;
char* relatedVariable3;
//@}
6

Я установил опцию "DISTRIBUTE_GROUP_DOC" на вкладке "эксперт". Все члены группы получили один и тот же комментарий.

//@{
/** same comment for all members */
char aaa;
char bbb;
int ccc;
//@}
1