1. 安装doxygen
- sudo apt install doxygen
- sudo apt install graphviz(生成dot需要)
2. 创建Doxyfile.in文件
- 注:可使用
doxygen -g
命令生成默认的Doxyfile,cmake则是通过Doxyfile.in来生成Doxyfile
# 项目名称,将作为于所生成的程序文档首页标题
PROJECT_NAME = “xxx”
# 文档版本号,可对应于项目版本号,譬如 svn、cvs 所生成的项目版本号
PROJECT_NUMBER = "1.0.0"
PROJECT_BRIEF = "xxx"
# 程序文档输出目录
OUTPUT_DIRECTORY = docs
# 程序文档输入目录
INPUT = @CMAKE_CURRENT_LIST_DIR@/apps \
@CMAKE_CURRENT_LIST_DIR@/include \
@CMAKE_CURRENT_LIST_DIR@/modules \
@CMAKE_CURRENT_LIST_DIR@/samples
# 程序文档语言环境
OUTPUT_LANGUAGE = Chinese
DOXYFILE_ENCODING = UTF-8
# 只对头文件中的文档化信息生成程序文档
FILE_PATTERNS &