Как добавить комментарии Doxygen для переменных "C" с длинными именами типов - PullRequest
3 голосов
/ 14 июня 2011

У меня есть код

   static const guint8 variable;

, когда я помещаю документацию

/**
 * \var static const guint8 variable;
 * \brief This is a variable
 */
static const guint8 variable;

Я не получаю вывод в сгенерированной документации.Однако, когда то же самое делается с простым объявлением переменной:

/**
 * \var int someothervar;
 * \brief This is some other variable
 */
int variable;

это работает

, что я делаю какую-то ошибку в использовании?

СпасибоЗа любую помощь заранее,

- elechi

1 Ответ

8 голосов
/ 15 июня 2011

Для извлечения статических переменных вы должны установить для EXTRACT_STATIC значение YES.

Если документация находится перед переменной, вам не нужно (и не следует использовать) \ var

Любой наборEXTRACT_ALL для YES или добавьте комментарий с помощью команды @file в своем коде для документирования самого файла.

...