Doxygen介绍和使用

简介

Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统.。Doxgen可以从一套源文件开始，生成HTML格式的在线类浏览器，或离线的LATEX、RTF参考手册，LATEX可以转成PDF。简单来说，Doxygen 的使用可分为两大部分，首先是按照特定的格式在源代码里面写注释，第二便是使用Doxygen工具来产生好看的说明文档了。

安装

doxygen是使用graphviz工具来绘图的，doxygen-gui是doxygen的图形化界面

sudo apt-get install doxygen
sudo apt-get install graphviz
sudo apt-get install doxygen-gui

使用

• 在符合doxygen要求的注释代码源文件的目录下，生成配置文件Doxyfile

doxygen -g

• 修改配置文件Doxyfile，常用的配置如下

# 项目名称，将作为于所生成的程序文档首页标题
PROJECT_NAME        = “Test”
 
# 程序文档语言环境
OUTPUT_LANGUAGE      = Chinese
 
# 只对头文件中的文档化信息生成程序文档
FILE_PATTERNS        =
 
# 递归遍历当前目录的子目录，寻找被文档化的程序源文件
RECURSIVE            = YES

# 如果是制作 C 程序文档，该选项必须设为 YES，否则默认生成 C++ 文档格式
OPTIMIZE_OUTPUT_FOR_C  = YES
 
# 提取信息，包含类的私有数据成员和静态成员
EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = YES
EXTRACT_STATIC        = YES

# 对于使用 typedef 定义的结构体、枚举、联合等数据类型，只按照 typedef 定义的类型名进行文档化
TYPEDEF_HIDES_STRUCT  = YES

# 在 C++ 程序文档中，该值可以设置为 NO，而在 C 程序文档中，由于 C 语言没有所谓的域/名字空间这样的概念，所以此处设置为 YES
HIDE_SCOPE_NAMES      = YES

# 让 doxygen 静悄悄地为你生成文档，只有出现警告或错误时，才在终端输出提示信息
QUIET  = YES

# 递归遍历示例程序目录的子目录，寻找被文档化的程序源文件
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

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

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

其余的配置的解释请参考《doxygen_manual-1.8.15.pdf》文档中的对应的英文解释部分。

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

doxygen Doxyfile

生成html目录后，用浏览器打开index.html，即可浏览生成的文档。

• 图形化界面doxywizard
doxywizard 是 doxygen的图形化界面， 可以把doxygen的配置文件，以图形化的方式表现出来，并且最终也可以生成相应的配置文件和文档。