Linux下Doxygen的安装配置与使用

date: 2015.05.04; modification:2015.05.04

目录:

1 简介

Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统. Doxgen可以从一套源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX、RTF参考手册。LATEX也可以转成PDF.

Doxygen 的使用可分为两大部分。首先是特定格式的批注撰写,第二便是利用Doxygen的工具来产生文件。

1.1 语言支持

1.2 生成的文档格式

2 安装

2.1 Ubuntu/Debian安装

sudo apt-get install doxygen

2.2 源码安装

可在官网下载包: 如doxygen-1.7.4.linux.bin.tar.gz

命令:

tar xvfz doxygen-1.7.4.linux.bin.tar.gz
cd doxygen-1.7.4
./configure
make
sudo make install

3 配置

3.1 生成配置文件

进入项目目录:

doxygen -g

该命令会在当前路径生成一个名为Doxyfile配置文件.

Doxyfile 文件内容非常多,大概 1000 多行,不过其中约 4/5 都是注释,每个配置选项都有一段详细的注释。日后,如果对 Doxygen 各配置选项的意义有一定了解,可以在生成配置文件的命令中添加 "-s" 选项,生成不含注释的配置文件,操作如下:

doxygen -s -g

3.2 常用配置

执行完上面的生成命令, 已经有个模板Doxyfile,可以根据需要更改相应设置:

# 项目名称,将作为于所生成的程序文档首页标题
PROJECT_NAME           = “Test

# 文档版本号,可对应于项目版本号,譬如 svn、cvs 所生成的项目版本号
PROJECT_NUMBER       = "1.0.0

# 程序文档输出目录
OUTPUT_DIRECTORY    =  out/

# 程序文档语言环境
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         = YES

# 在程序文档中允许以图例形式显示函数调用关系,前提是你已经安装了 graphviz 软件包
HAVE_DOT               = YES
CALL_GRAPH             = YES
CALLER_GRAPH           = YES

#让doxygen从配置文件所在的文件夹开始,递归地搜索所有的子目录及源文件
RECURSIVE = YES  

#在最后生成的文档中,把所有的源代码包含在其中
SOURCE_BROWSER = YES

$这会在HTML文档中,添加一个侧边栏,并以树状结构显示包、类、接口等的关系
GENERATE_TREEVIEW = ALL

4 填写注释

Doxygen就是从源代码文件的注释中提取文档. 所以生成文档之前, 就是要按照Doxygen的风格来编写注释.

4.1 头文件注释:

/** @brief   这里写你的摘要
 *  @file    你的文件名
 *  @author  作者
 *  @version 版本
 *  @date    日期
 *  @note    注解. 例如: 本文件有什么具体功能啊, 使用时要注意什么啊..
 *  @since   自从...
 */

4.2 函数的注释:

/**  这里写这个函数的概述
 @param[in]  输入参数1
 @param[in]  输入参数2
 @param[out] 输出参数1
 @return     返回值解释一下
 @warning    警告: 例如: 参数不能为空之类的
 @note       注解
 @see        类似于请参考xxoo函数之类的
*/

更多注释规则请查阅: Doxygen的注释规则

5 程序文档生成

在上面生成的Doxyfile所在的路径, 输入

doxygen your-cfg-filename

your-cfg-filename 是 Doxygen 配置文件名,如果是使用 "doxygen -g" 生成的默认配置文件 -- Doxyfile,那么可以在终端里仅键入 "doxygen" 命令即可生成程序文档。

如果按照本文配置, 在out目录下, 会有html, latex文件夹. 使用浏览器打开html目录中的 index.html 文件,即可看到自己的工作成果。

6 转为pdf

如果装了latex环境, 到latex下make即可生成pdf. 对于需要中文环境的, 请参考: Linux下Doxygen生成中文pdf文档

7 参考文档

http://blog.chinaunix.net/uid-21809556-id-1814825.html