Документирование нескольких перечислений / переменных с одинаковым описанием в doxygen - PullRequest
1 голос
/ 21 августа 2010

Можно ли задокументировать несколько перечислений / переменных с помощью одной и той же документации?

Например:

enum
{
   /// Description of Values
   VALUE_1 = 0,
   VALUE_2 = 1,
   VALUE_3 = 2
};

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

Ответы [ 2 ]

1 голос
/ 14 января 2014

Вы можете задокументировать все перечисление вместо отдельных значений.

/// Description of Values
enum
{
   VALUE_1 = 0,
   VALUE_2 = 1,
   VALUE_3 = 2
};
0 голосов
/ 26 августа 2010

Группы пользователей может быть тем, что вы ищете.

...