如何记录Doxygen中不存在的变量？

Question

例如，我有一个$ theme全局变量，它在配置文件中定义，Doxygen不处理。但我想记录它。我试着这样做：

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

但它不起作用。

Answer 1

您可以创建一个doxygen特定文件来记录变量，例如：

config.dox

/**
 * @defgroup configuration Configuration
 */

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

这将创建一个名为“Configuration”的新Doxygen模块，它将包含变量$theme。您还可以将$theme与特定类相关联（使用@memberof代替@ingroup）。