c - 使用 doxygen 记录配置宏

Question

我想用 doxygen 记录一个配置宏。该宏未在源代码中定义，但需要使用编译器定义设置进行定义。

由于我没有定义，我尝试了类似以下内容，我在 doxygen 手册中找到了它(我将此代码段添加到使用宏进行条件编译的 header 中):

/*! \def MY_CONFIG_MACRO
    \brief Brief

    Details.
*/

但是，该文档不会出现在生成的 HTML 文件中。知道为什么上述不起作用吗？如何在使用它的上下文中记录编译器定义的宏？

Answer 1

遇到了同样的问题，解决方法如下:

在doxygen配置文件中添加:

PREDEFINED = IN_DOXYGEN

在源代码的某处添加:

/*
  Exporting cmake compilation flags to doxygen,
  so they get documented.
*/
#ifdef IN_DOXYGEN
#define MY_CONFIG_MACRO
#endif /* IN_DOXYGEN */

然后正确获取 MY_CONFIG_MACRO 的文档。