Doxygen C++ 如何将宏展开生成的成员函数归入同一文档分组
解决方案
方案1:仅修改Doxygen配置(无需改动业务代码)
这是侵入性最低的方案,不需要修改你原有的C++代码,只需要调整Doxygen的配置文件:
- 打开你的Doxyfile配置文件,找到以下配置项并修改为对应值:
MACRO_EXPANSION = YES开启宏展开功能PREDEFINED += FOO(x)=/** @name MyGroup @{ */ void x(); /** @} */为Doxygen单独指定FOO宏的展开规则
- 重新生成Doxygen文档即可。
这个方案下,Doxygen处理代码时会自动把所有FOO(funcName)的调用展开为带分组标记的函数声明,原代码里每个宏上方的@brief注释会自动关联到生成的函数上,不会丢失。且同名称的MyGroup分组会被Doxygen自动合并,所有FOO生成的函数都会归入同一个分组。
方案2:修改代码中的宏定义(适配多场景)
如果你需要在代码里显式标记分组规则,可以修改宏定义,通过编译宏隔离Doxygen专属的逻辑,不影响正常编译:
#ifdef DOXYGEN // Doxygen处理时的宏定义,内嵌分组标记 #define FOO(x) /** @name MyGroup @{ */ void x(); /** @} */ #else // 正常编译时的原始宏定义 #define FOO(x) void x() #endif
然后在Doxyfile中添加配置:
MACRO_EXPANSION = YESPREDEFINED += DOXYGEN=1
两种方案的最终效果都和你手动编写分组标记的文档效果完全一致,且可以保留每个函数原有的注释内容。
内容的提问来源于stack exchange,提问作者Patrick Wright
相关产品推荐
相关产品推荐

