Ubuntu系统使用Doxygen生成文档

1 简介：

　　Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统. Doxgen可以从一套源文件开始，生成HTML格式的在线类浏览器，或离线的LATEX、RTF参考手册。LATEX也可以转成PDF. Doxygen 的使用可分为两大部分。首先是特定格式的批注撰写，第二便是利用Doxygen的工具来产生文件。

1.1 语言支持

• C/C++
• Java
• Objective-C
• Python
• IDL (Corba,Microsoft及KDE-Dcop类型)
• Fortran
• VHDL
• PHP
• C#

1.2 生成的文档格式

• HTML
• XML
• LaTeX
• RTF (MS-Word),可以用作转pdf
• PostScript
• Unix Man Page

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

其实基本使用者只需要下面修改5个地方：
1.projectName名字
2.生成的文件格式，因为只需要html格式的文档，所以搜索LaTeX，把其输出改为no即可，就是只生成html格式的文档．
3.RECURSIVE = YES 这可以让doxygen从配置文件所在的文件夹开始，递归地搜索所有的子目录及源文件
4.EXAMPLE_RECURSIVE忽略文件夹　EXCLUDE忽略文件　一般EXCLUDE和EXAMPLE_RECURSIVE配合使用（在文章最下部会有使用实例截图）
5.mainpage:在mainpage.h文件中写完整的文件路径才可从mainpage跳转,但是最后的文件名后边不能添加类似.java（在文章最下部会有使用实例截图）

4 填写注释

Doxygen就是从源代码文件的注释中提取文档. 所以生成文档之前,就是要按照Doxygen的风格来编写注释，网上一搜会有很多标准的Doxygen注释规范.（在文章最下部会有java使用实例截图）

5 程序文档生成

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

doxygen your-cfg-filename

如果没有修改名字的话，其实就是

doxygen Doxyfile

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

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

6 转为pdf

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

7 实例链接地址

https://fossies.org/dox/lucene-7.1.0-src/

８ 参考地址

http://www.doxygen.nl/

http://www.mikewootc.com/wiki/tool/sw_develop/doxygen_get_start.html

9 寄语

这该是比较完整的Doxygen使用，除了注释规范（网上都有，本文章只有类和方法注释实例图一张，在最底部），自己做个笔记，希望对你也有帮助！

原文地址：https://www.jb51.cc/ubuntu/350496.html