如何配置Doxygen 1.8.17仅生成带Doxygen注释的函数文档
如何配置Doxygen 1.8.17仅生成带Doxygen注释的函数文档
当然可以实现这个需求!要让Doxygen 1.8.17只生成带有Doxygen注释的函数文档,你只需要调整Doxyfile里的几个关键配置项就行,具体操作如下:
关键配置调整
你需要在你的Doxyfile中添加或修改以下两个核心配置:
- 设置
EXTRACT_ALL = NO:这是最关键的一项。默认情况下EXTRACT_ALL可能是YES,会强制Doxygen提取所有代码实体(不管有没有注释);将它设为NO后,Doxygen就只会处理带有完整Doxygen注释的函数、类等内容。 - 设置
HIDE_UNDOC_MEMBERS = YES:这个配置会让Doxygen隐藏所有没有文档注释的成员,和上面的配置配合,能确保未注释的函数完全不出现在生成的文档里。
修改后的Doxyfile片段
结合你现有的Doxyfile配置,修改后应该是这样的:
PROJECT_NAME = "Kyle's Doxygen Test" PROJECT_NUMBER = "This is just a test of Doxygen" GENERATE_LATEX = NO INCLUDE_GRAPH = NO INCLUDED_BY_GRAPH = NO # 添加以下配置项 EXTRACT_ALL = NO HIDE_UNDOC_MEMBERS = YES
验证效果
配置完成后,重新运行doxygen Doxyfile生成文档,你会发现只有带有完整Doxygen注释的add函数会出现在文档中,而没有注释的showInt函数会被完全排除在外。
备注:内容来源于stack exchange,提问作者vico
相关产品推荐
相关产品推荐

