1. 简介

Doxygen能将程序中的特定批注转换成为说明文件。它可以依据程序本身的结构，将程序中按规范注释的批注经过处理生成一个纯粹的参考手册，通过提取代码结构或借助自动生成的包含依赖图（include dependency graphs）、继承图（inheritance diagram）以及协作图（collaboration diagram）来可视化文档之间的关系， Doxygen生成的帮助文档的格式可以是CHM、RTF、PostScript、PDF、HTML等。

2. 安装

sudo apt-get install graphviz doxygen doxygen-gui

3. 文件配置

doxygen -g Doxygen.config  # 生成配置文件 

 如下就是配置文件中的常用信息，对新手来说不太直观。

# 项目名称，将作为于所生成的程序文档首页标题
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. 可视化配置

运行下面命令即跳出可视化配置界面

doxywizard

4.1. 配置工程信息

4.2. 配置模式

4.3. 配置输出项

4.4. 配置图表

 

4.5. 配置[Expert]

语言选择中文

 [Expert]往下拉到[dot], DOT_PATH选择为/usr/bin

运行

此处可点击【Run doxygen】, 输出框会显示输出内容。

或者关闭窗口，保存配置项，通过命令生成文件。关闭窗口跳出如下框图：

选择【Save】,保存配置文件Doxyfile。

执行命令：doxygen Doxyfile， 待运行结束。

5. 使用

vi Doxygen.config          # 修改配置文件
RECURSIVE              = YES 
doxygen Doxygen.config     # 根据代码生成文档

生成的文档在html目录下，生成的类继承图如下：

参考文献

• 怎么由C++代码生成UML类图? - 知乎
• Doxygen快速入门 - 知乎
• https://blog.csdn.net/zhonglinliu/article/details/78604397?utm_medium=distribute.pc_relevant.none-task-blog-2%7Edefault%7EBlogCommendFromBaidu%7Edefault-6.control&depth_1-utm_source=distribute.pc_relevant.none-task-blog-2%7Edefault%7EBlogCommendFromBaidu%7Edefault-6.control
• 源码查看利器-利用doxygen和graphviz将源码生成调用关系图_嵌入式开发，欢迎交流-CSDN博客