面向 Doxygen 的基本教程。
以下操作均在 Ubuntu 18.04 bionic 下验证通过。
提取相应的包。
$ tar -xzvf doxygen-1.8.17.linux.bin.tar.gz
$ cd doxygen-1.8.17
$ ./configure
这个时候执行 make 命令会失败，需要修改下 Makefile 文件。
# make = make install
$ make
生成配置文件模板。
$ doxygen -g
如果是C/C++工程，你需要在默认生成的 Doxyfile 的基础上添加以下配置：
# line 35: 工程名称
PROJECT_NAME = "PQLIB"
# line 41: 版本号
PROJECT_NUMBER = "0.1.0"
# line 61: 文档输出目录
OUTPUT_DIRECTORY = .
# line 94: 文档语言环境
OUTPUT_LANGUAGE = Chinese
# line 470: 提取所有文档信息，类的私有成员及文件的静态成员除外
EXTRACT_ALL = YES
# line 476: 提取类的私有成员的信息
EXTRACT_PRIVATE = YES
# line 494: 提取文件的静态成员的信息
EXTRACT_STATIC = YES
# line 832: 文档输入目录
INPUT = .
# line 1546: 添加树形结构的侧边栏
GENERATE_TREEVIEW = YES
# line 1740: 不生成latex格式的文档
GENERATE_LATEX = NO
生成文档。
$ doxygen Doxyfile