doxygen 快速入门

一、资料

doxygen 的百度百科，推荐看一下

二、安装 doxygen（依赖 git 和 cmake）

git clone https://github.com/doxygen/doxygen.git
cd doxygen
mkdir build
cd build
cmake -G “Unix Makefiles” ..
make
sudo make install

三、生成默认配置并编辑

cd project_dir
doxygen -g doxygen_cfg
open -t doxygen_cfg
须重点关注的 tag（支持相对路径，诸如 ./src）：
PROJECT_NAME 工程名
PROJECT_VERSION 工程版本
OUTPUT_DIRECTORY 输出目录
OUTPUT_LANGUAGE 输出语言（默认 en）
INPUT 输入目录（以，分隔）
FILE_PATTERNS 文件类型
RECURSIVE 是否递归（默认 NO）

四、生成

doxygen doxygen_cfg
完了以后发现在 OUTPUT_DIRECTORY 中多了 html 和 latex 两个目录
生成的文档就位于这两个目录中了