记录 Doxygen 中定义的预处理器

Question

是否可以在 Doxygen 中记录预处理器定义？我期望能够像变量或函数一样执行此操作，但是 Doxygen 输出似乎“丢失”了定义的文档，并且也不包含定义本身。

我尝试了以下操作

/**My Preprocessor Macro.*/
#define TEST_DEFINE(x) (x*x)

，还

/**@def TEST_DEFINE

   My Preprocessor Macro.
*/
#define TEST_DEFINE(x) (x*x)

尝试将它们放入一个组中（尝试了 defgroup、addtogroup 和 ingroup），而不仅仅是在“文件范围”中，但这也没有效果（尽管组中的其他项目已按预期记录）。

我查看了各种 Doxygen 选项，但没有看到任何可以启用（或阻止）定义文档的内容。

Answer 1

是的，这是可能的。 Doxygen 文档 说：

记录全局对象（函数、typedef、枚举、宏等），
您必须记录定义它们的文件。换句话说，
至少必须有一个

<代码>/*! \文件*/

或

<代码>/** @file */

此文件中的行。

行。您可以使用 @defgroup、@addtogroup 和 @ingroup 将相关项放入同一模块中，即使它们出现在单独的文件中（有关详细信息，请参阅文档此处）。这是一个适合我的最小示例（使用 Doxygen 1.6.3）：

Doxyfile:

# Empty file.

Test.h:

/** @file */

/**My Preprocessor Macro.*/ 
#define TEST_DEFINE(x) (x*x) 

/**
 * @defgroup TEST_GROUP Test Group
 *
 * @{
 */

/** Test AAA documentation. */
#define TEST_AAA (1)
/** Test BBB documentation. */
#define TEST_BBB (2)
/** Test CCC documentation. */
#define TEST_CCC (3)
/** @} */

Foo.h:

/** @file */

/**
 * @addtogroup TEST_GROUP
 *
 * @{
 */

/** @brief My Class. */     
class Foo {
    public:
        void method();
};

/** @} */

Bar.h：

/** @file */

/**
 * @ingroup TEST_GROUP
 * My Function.
 */
void Bar();

在本例中，TEST_DEFINE 文档显示在 HTML 中 Files 选项卡下的 Test.h 条目中输出，并且 TEST_AAA 等定义与类 Foo 和函数一起出现在 Modules 选项卡中的 Test Group 下酒吧。

需要注意的一件事是，如果将文件名放在 @file 命令后面，例如：

/** @file Test.h */

那么这必须与文件的实际名称匹配。如果没有，则不会生成文件中项目的文档。

如果您不想添加 @file 命令，另一种解决方案是在 Doxyfile 中设置 EXTRACT_ALL = YES。

我希望这有帮助！

Answer 2

在我的“C”文件中，我使用注释格式和#define 行，如下所示：

/** @brief Number of milli-seconds to wait*/
#define kTimeoutMSec (2)

我的 html 文档最终包含我指定的文档。 （我确实在文件顶部有 @file 并且 EXTRACT_ALL=YES）

Answer 3

尝试设置 EXTRACT_ALL 选项，我在我的项目中设置了该选项，它会生成 #defines 的文档。可能有一种更优雅的方法，无需使用 EXTRACT_ALL 即可完成此操作，因此请务必查看文档

http: //www.doxygen.nl/config.html#cfg_extract_all

Answer 4

除了前面的答案之外，还需要在 Doxyfile 上设置 ENABLE_PREPROCESSING=YES。