Doxygen комментировать несколько переменных одновременно

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

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

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

ИЗМЕНИТЬ Следуя предложениям envu, теперь у меня есть следующее (основанное на http://www.stack.nl/~dimitri/doxygen/grouping.html#memgroup)

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

или

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

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

Ответ 1

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

Ответ 2

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

Ответ 3

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

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

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

Пример:

/*! \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;
//@}

Ответ 4

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

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