如何在Doxygen 1.9.1中隐藏C项目宏的展开内容?
隐藏Doxygen中宏的展开内容方法
针对Doxygen 1.9.1,有几种实用方法可以隐藏宏的实现细节,只展示宏名称和功能说明:
方法一:使用@hideinitializer注释命令
在宏的文档注释中添加@hideinitializer,这是最直接的方式,告诉Doxygen不要显示宏的展开内容:
/** * @brief Does a thing. * @hideinitializer */ #define DO_THING() someFunc(1, 2, 3)
方法二:修改Doxygen配置文件
调整Doxyfile中的参数,全局控制宏的展开行为:
- 找到
MACRO_EXPANSION选项,设置为NO:
这个配置会让Doxygen不自动展开所有宏,仅显示宏的定义名称。如果项目中有部分宏需要展开,可以结合MACRO_EXPANSION = NOEXPAND_ONLY_PREDEF和PREDEFINED选项,指定仅展开特定宏。
方法三:手动用@def定义宏
通过@def命令手动声明宏的显示内容,替代Doxygen自动解析的展开结果:
/** * @brief Does a thing. * @def DO_THING() */ #define DO_THING() someFunc(1, 2, 3)
这种方式下,Doxygen会完全按照你@def中指定的内容展示宏,不会解析并显示其展开后的代码。
内容的提问来源于stack exchange,提问作者Daniel Walker
相关产品推荐
相关产品推荐

