doxygen简介
Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统。
目前完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。
注释的语法与Qt-Doc、KDoc和JavaDoc兼容。
Doxygen可以从一套归档源文件开始，生成HTML格式的在线类浏览器，或离线的LATEX、RTF、MAN参考手册。
Mac OS 安装
brew install doxygen
doxygen快速入门
生成配置文件
使用doxygen -g命令生成doxygen配置文件`。
配置完毕后，使用doxygen Doxyfile来生成文档。
预览
在html文件夹中用浏览器打开index.html就可以打开html文档的首页。
详细的配置请见Doxyfile配置
Doxyfile配置
这个文件中自动生成来很多属性，通过设置这些属性，可以改变文档的结构，定制我们想要的文档。
使用你的编辑器的快速搜索来找到这些标签并学会设置他们。
PROJECT_NAME 项目名字
PROJECT_NAME = "your project name"
PROJECT_BRIEF 项目简介
PROJECT_BRIEF = "brief describe"
OUTPUT_LANGUAGE 文档输出语言
设成Chinese或者English等等。
DOXYFILE_ENCODING DoxyFile编码
DoxyFile文件本身的编码格式，一般用UTF-8。
INPUT_ENCODING 输入文件编码
源代码文件的编码，一般用UTF-8。
INPUT 输入
一个以空格分隔的目录列表，包含需要创建文档的C/C++源代码文件和头文件。例如：
INPUT = README.md helloworld.cpp
Doxygen可以把md文件设置为首页，加入README.md是为了丰富我们空白的首页。
FILE_PATTERNS 支持的文件扩展名。
FILE_PATTERNS = *.c \
*.cpp \
*.h \
*.hpp \
RECURSIVE 支持嵌套文档
如果源代码层次结构是嵌套的，而且需要为所有层次上的C/C++文件生成文档，就把这个标记设置为TES。
EXTRACT_PRIVATE 提供私有成员文档
把这个标记设置为YES。否则，文档不包含类的私有数据成员。
EXTRACT_STATIC 提供静态成员文档
把这个标记设置为YES。否则，文档不包含文件的静态成员。
GENERATE_MAN UNIX手册
设置成YES，以支持man查询。
GENERATE_LATEX LaTeX手册
设置成YES，会生成LaTeX手册。
CLASS_DIAGRAMS 类继承层次结构图
默认设置为YES。如果这个标记设置为NO，就不生成继承层次结构图。
