Как документировать переменную, которой нет в Doxygen?

Question

Например, у меня есть глобальная переменная $ theme, определенная в файле конфигурации, которая не обрабатывается Doxygen. Но я хочу это задокументировать. Я пытался сделать это:

/**
 * @var $theme
 * @brief Active theme.
 */

но это не сработало.

Answer 1

Вы можете создать специфичный для doxygen файл для документирования переменных, например:

config.dox

/**
 * @defgroup configuration Configuration
 */

/**
 * @ingroup configuration
 * @brief Active Theme
 */
$theme;

Это создаст новый модуль Doxygen с именем «Configuration», который будет содержать переменную $theme. Вы также можете связать $theme с определенным классом (используйте @memberof вместо @ingroup).