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

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

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

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


php doxygen
person lamefun    schedule 16.01.2012    source источник
comment
Поддерживает ли Doxygen файл @global phpDocumentor?   -  person Charles    schedule 17.01.2012

Ответы (1)


arrow_upward
4
arrow_downward

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

config.dox

/**
 * @defgroup configuration Configuration
 */

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

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

person DRH    schedule 17.01.2012