如何记录Doxygen中确实不存在的变量？ [英] How to document a variable that isn't really there in Doxygen?

问题描述

例如，我有$ theme全局变量，该全局变量在配置文件中定义，Doxygen不会对其进行处理。但我想记录下来。我试图这样做：

For example, I have $theme global variable that is defined in the configuration file, which is not processed by Doxygen. But I want to document it. I tried to do this:

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

但没有用。

推荐答案

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

You can create a doxygen specific file for documenting variables, something like:

/**
 * @defgroup configuration Configuration
 */

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

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

This will create a new Doxygen module named "Configuration" which will contain the variable $theme. You could also associate $theme with a particular class (use @memberof instead of @ingroup).

这篇关于如何记录Doxygen中确实不存在的变量？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！