用 doxygen 记录配置宏
Document a config macro with doxygen
我想用 doxygen 记录一个配置宏。该宏未在源代码中定义，但需要使用编译器定义设置进行定义。
因为我没有定义，所以我尝试了在 doxygen 手册中找到的类似以下内容（我将此片段添加到使用宏进行条件编译的 header）：
/*! \def MY_CONFIG_MACRO
\brief Brief
Details.
*/
但是，该文档不会出现在生成的 HTML 文件中。知道为什么以上不起作用吗？如何在使用它的上下文中记录编译器定义的宏？
遇到了同样的问题，是这样解决的：
在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 的文档被正确提取。
我想用 doxygen 记录一个配置宏。该宏未在源代码中定义，但需要使用编译器定义设置进行定义。
因为我没有定义，所以我尝试了在 doxygen 手册中找到的类似以下内容（我将此片段添加到使用宏进行条件编译的 header）：
/*! \def MY_CONFIG_MACRO
\brief Brief
Details.
*/
但是，该文档不会出现在生成的 HTML 文件中。知道为什么以上不起作用吗？如何在使用它的上下文中记录编译器定义的宏？
遇到了同样的问题，是这样解决的：
在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 的文档被正确提取。