Doxygen配置

1 安装

• windows：
• doxygen提供了exe可直接安装，安装后可能需要将可执行性文件路径加入path环境变量中
• Linux：参考官网

2 使用

2.1 步骤

1. 生成配置文件Doxyfile：doxygen -g
2. 编辑配置文件Doxyfile
3. 生成文档：doxygen

2.2 Doxyfile文件配置

• PROJECT_NAME：生成的文档标题，如html文档tital，默认是My Project
• OUTPUT_DIRECTORY：文档的生成目录
• INPUT：源文件位置,多个路径空格隔开，如INPUT= ../include src
• RECURSIVE：是否查找子目录下源文件，YES是，NO否，如RECURSIVE= YES
• EXTRACT_ALL：当设置YES时所有注释都会生成文档
• EXTRACT_PRIVATE：设置YES时私用成员会被文档化
• EXTRACT_STATIC：设置YES时静态成员会被文档化 更多设置请移步官网

3 问题汇总

• 文件头声明的@file指令会在html文档导航栏产生file标签
• 在任意文件注释包含@mainpage指令会在html文档的MainPage产生信息
• 源码文件含有命名空间，在html文档导航栏会产生namespaces标签
• 链接函数需要把函数参数带上 在官网有大量问题及解答，请移步官网