Doxygen文档系统---入门

Doxygen简介：Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxygen可以从一套归档源文件开始，生成HTML格式的在线类浏览器，或离线的LATEX、RTF参考手册。

一. 安装

1. 下载二进制文件

./configure
make install

note:

1. make install_docs 安装文档和示例；
2. 通过configue文件的-prefix改变安装路径。
   2. 软件包安装

sudo apt install doxygen //版本低

3. 从源码编译

二. 运行

doxygen -s -g <config-file> //生成配置文件，config-file为配置文件，默认为Doxyfile. -s为省略配置文件的注释（一般不加）
doxygen <config-file> //执行配置文件，生成输出目录

三.配置文件Doxyfile(默认)修改
常见需要修改的一些配置：
PROJECT_NAME ：项目名称
PROJECT_NUMBER : 版本号
OUTPUT_DIRECT