一、简介Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始，生成HTML格式的在线类浏览器，或离线的LATEX、RTF参考手册。二、安装需安装doxygen和用于支持doxygen的图像化工具graphviz，步骤如下：1、安装doxygen1、资源下载：doxygen-1.7.4.linux.bin.tar.gz~dimitri/doxygen/download.html2、编译安装1) tar xvfz doxygen-1.7.4.linux.bin.tar.gz2) cd doxygen-1.7.43) ./configure4) make5) make install2、安装graphviz1、执行如下命令即可完成安装yum install graphviz
三、配置使用1、在项目工程目录下生成配置文件cd test/ #进入项目目录（test为例说明）Doxygen –g #生成配置文件提示：1、默认生成的配置文件名为 “Doxyfile”，也可以指定生成的配置文件名：doxygen -g your-cfg-filename2、可以在生成配置文件的命令中添加 “-s” 选项，生成不含注释的配置文件：doxygen -sg2、根据需要，修改配置文件模板下载：
——————————————分割线——————————————
免费下载地址在
用户名与密码都是
具体下载目录在 /2015年资料/4月/23日/Linux下Doxygen的安装和使用/
下载方法见
——————————————分割线——————————————
常用选项如下：
# 项目名称，将作为于所生成的程序文档首页标题PROJECT_NAME = “Test”# 文档版本号，可对应于项目版本号，譬如 svn、cvs 所生成的项目版本号PROJECT_NUMBER = “1.0.0# 程序文档输出目录OUTPUT_DIRECTORY = /home/user1/docs# 程序文档输入目录 INPUT = /home/user1/project/kernel# 程序文档语言环境OUTPUT_LANGUAGE = Chinese# 只对头文件中的文档化信息生成程序文档 FILE_PATTERNS = # 递归遍历当前目录的子目录，寻找被文档化的程序源文件 RECURSIVE = YES # 如果是制作 C 程序文档，该选项必须设为 YES，否则默认生成 C++ 文档格式OPTIMIZE_OUTPUT_FOR_C = YES#提取信息，包含类的私有数据成员和静态成员EXTRACT_ALL = yesEXTRACT_PRIVATE = yesEXTRACT_STATIC = yes# 对于使用 typedef 定义的结构体、枚举、联合等数据类型，只按照 typedef 定义的类型名进行文档化TYPEDEF_HIDES_STRUCT = YES# 在 C++ 程序文档中，该值可以设置为 NO，而在 C 程序文档中，由于 C 语言没有所谓的域/名字空间这样的概念，所以此处设置为 YESHIDE_SCOPE_NAMES = YES# 让 doxygen 静悄悄地为你生成文档，，只有出现警告或错误时，才在终端输出提示信息QUIET = YES# 递归遍历示例程序目录的子目录，寻找被文档化的程序源文件EXAMPLE_RECURSIVE = YES# 允许程序文档中显示本文档化的函数相互调用关系REFERENCED_BY_RELATION = YESREFERENCES_RELATION = YESREFERENCES_LINK_SOURCE = YES# 不生成 latex 格式的程序文档GENERATE_LATEX = NO# 在程序文档中允许以图例形式显示函数调用关系，前提是你已经安装了 graphviz 软件包HAVE_DOT = YESCALL_GRAPH = YESCALLER_GRAPH = YES#在最后生成的文档中，把所有的源代码包含在其中SOURCE BROWSER = YES$这会在HTML文档中，添加一个侧边栏，并以树状结构显示包、类、接口等的关系GENERATE TREEVIEW ＝ ALL3、程序注释文档化使用Doxygen，需要按照Doxygen 的游戏规则来对程序源码进行文档化。 Doxygen 的注释类型可分为： 1、行间注释：注释语句不与程序源码出现在同一行，主要用于注释头文件中出现的结构体 (struct)、枚举 (enum)、联合 (uion) 等数据类型，以及程序接口的功能与使用约定；2、行内注释：注释语句与程序源码出现在同一行内，主要用于代码的局部注释。详细语法参考：~dimitri/doxygen/manual/docblocks.html4、文档生成cd test/doxygen提示：可以指定配置文件名：doxygen your-cfg-filename
5、文档使用生成的文档位于test/doc/html 目录中，使用浏览器打开该目录中的 index.html 文件，即可看到自己的工作成果。
Ubuntu 12.04下使用Doxygen生成API文档
本文永久更新链接地址：
出门走好路，出口说好话，出手做好事。
