标签：linux操作系统 c++ 状态 gen 默认的配置 意义 开始 标题 文件
1.安装doxygen
目前最新版本的的doxygen是doxygen1.8.13，安装包可以在官网上下载，网址是：http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc。
从官网下载的时候，先下载的是doxygen-1.8.13.src.tar.gz这个安装包，发现只有这一个安装包用不了，没有可执行的configure文件和makefile文件，需要再下载另外一个安装包doxygen-1.8.13.linux.bin.tar.gz。中文版Linux操作系统中下载之后默认存在“下载”文件夹中，英文版Linux操作系统中下载之后默认存在“Downloads”文件夹中。
下载完成后，打开termianal输入指令：
(1)cd 下载
(2)tar xvfz doxygen-1.8.13.src.tar.gz
(3)tar xvfz doxygen-1.8.13.linux.bin.tar.gz
(4) cd doxygen-1.8.13
(5)./configure
(6)sudo make
(7)sudo make install
在安装的时候会遇到一些问题，如下图所示：
无法获取‘bin/doxytag’的文件状态，我们可以先看一下Makefile文件和bin文件夹，发现Makefile文件中需要用到的文件bin文件夹中并没有。
如果想要正确安装doxygen就要对Makefile文件进行修改。通过vim Makefile命令打开Makefile文件，根据bin文件夹中的有的文件来修改Makefile文件如下图：
然后再用命令sudo make install安装就可以了。
2.配置Doxygen工作环境
进入项目目录（ test 为例说明） cd test/
生成配置文件 Doxygen –g
默认生成的配置文件名为 "Doxyfile" ，也可以采用 "doxygen -g your-cfg-filename" 命令格式指定所生成的配置文件名。如无特殊需要，采用默认的配置文件名即可。
Doxyfile 文件内容非常多，大概 1000 多行，不过其中约 4/5 都是注释，每个配置选项都有一段详细的注释。日后，如果对 Doxygen 各配置选项的意义有一定了解，可以在生成配置文件的命令中添加 "-s" 选项，生成不含注释的配置文件，操作如下：
$ doxygen –s -g
3．配置文件的相应设置
接下来需要打开这个Doxygen文档，对其中某些字段做配置，一般来说，只需要配置其中十几个字段就可以：
# 项目名称，将作为于所生成的程序文档首页标题
PROJECT_NAME = “Test“
# 文档版本号，可对应于项目版本号，譬如 svn 、 cvs 所生成的项目版本号
PROJECT_NUMBER = "1.0.0”
# 程序文档输出目录
OUTPUT_DIRECTORY = doc/
# 程序文档语言环境
OUTPUT_LANGUAGE = Chinese
# 如果是制作 C 程序文档，该选项必须设为 YES ，否则默认生成 C++ 文档格式
OPTIMIZE_OUTPUT_FOR_C = YES
# 对于使用 typedef 定义的结构体、枚举、联合等数据类型，只按照 typedef 定义的类型名进行文档化
TYPEDEF_HIDES_STRUCT = YES
# 在 C++ 程序文档中，该值可以设置为 NO ，而在 C 程序文档中，由于 C 语言没有所谓的域 / 名字空间这样的概念，所以此处设置为 YES
HIDE_SCOPE_NAMES = YES
# 让 doxygen 静悄悄地为你生成文档，只有出现警告或错误时，才在终端输出提示信息
QUIET = YES
# 只对头文件中的文档化信息生成程序文档
FILE_PATTERNS = *.h
# 递归遍历当前目录的子目录，寻找被文档化的程序源文件
RECURSIVE = YES
# 示例程序目录
EXAMPLE_PATH = example/
# 示例程序的头文档 (.h 文件 ) 与实现文档 (.c 文件 ) 都作为程序文档化对象
EXAMPLE_PATTERNS = *.c *.h
# 递归遍历示例程序目录的子目录，寻找被文档化的程序源文件
EXAMPLE_RECURSIVE = YES
# 允许程序文档中显示本文档化的函数相互调用关系
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
REFERENCES_LINK_SOURCE = YES
# 不生成 latex 格式的程序文档
GENERATE_LATEX = NO
# 在程序文档中允许以图例形式显示函数调用关系，前提是你已经安装了 graphviz 软件包
HAVE_DOT = YES
CALL_GRAPH = YES
CALLER_GRAPH = YES
# 让 doxygen 从配置文件所在的文件夹开始，递归地搜索所有的子目录及源文件
RECURSIVE = YES
# 在最后生成的文档中，把所有的源代码包含在其中
SOURCE BROWSER = YES
$ 这会在 HTML 文档中，添加一个侧边栏，并以树状结构显示包、类、接口等的关系
GENERATE TREEVIEW ＝ ALL
4.程序源码文档化
Doxygen的工作环境准备好之后，如果想要使用Doxygen就必须在源码的注释中使用Doxygen要求的注释规则，不然Doxygen是不能识别的。
Doxygen的注释类型可以分为：
（1）行间类型：注释语句不与程序源码出现在同一行，主要用于注释头文件中出现的结构体 (struct) 、枚举 (enum) 、联合 (uion) 等数据类型，以及程序接口的功能与使用约定，如下所示：
/**
* 这是Doxygen认可的行间注释标记示例
*/
（2）行内注释：注释语句与程序源码出现在同一行内，主要用于代码的局部注释。如下图所示的就是Doxygen认可的行内注释标记。
struct job{
pthread_t tid; ///线程ID
Job next; ///下一个链表结点
Int val; ///结点值
}
5.程序文档生成
如果是使用“doxygen -g”生成的配置文件Doxyfile，那么在终端直接输入doxygen就可以生成程序文档，文档就存放在刚刚设置的doc文件夹中。
标签：linux操作系统 c++ 状态 gen 默认的配置 意义 开始 标题 文件
原文地址：http://www.cnblogs.com/Mr--Yang/p/6338095.html
