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 标签
• 链接函数需要把函数参数带上 在官网有大量问题及解答，请移步 官网