Question

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

由于我没有定义，我尝试了类似下面的内容，我在doxygen手册中找到了（我将这个片段添加到使用宏进行条件编译的标题中）：

/*! \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的文档。