Doxygen工具简单使用

一、简述

Doxygen是一款非常方便的文档生成工具，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java等语言，据说也支持python等。不仅可以根据注释生成文档，而且还能利用graphviz工具生成类图以及类中的函数调用关系，并且支持html、latex、rtf等格式的输出。

二、安装graphviz

https://www.graphviz.org/download/

yum install graphviz

三、安装doxygen

https://www.doxygen.nl/download.html

git clone https://github.com/doxygen/doxygen.git
cd doxygen
mkdir build
cd build
cmake -G "Unix Makefiles" ..
make
make install

四、使用

在项目目录执行下面命令

doxygen -g

此命令会生成一个Doxyfile文件

运行doxygen，运行之前最好将Doxyfile文件里的RECURSIVE改为YES

doxygen Doxyfile

运行此命令后目录下生成一个html和latex目录，在浏览器上打开html`目录中的index.html即可看到说明文档

五、Doxyfile文件参数说明

EXTRACT_ALL = NO //当设置为YES时，将提取所有类和函数的文档，包括没有文档注释的类和函数。如果设置为NO，则只提取具有文档注释的类和函数
EXTRACT_PRIVATE = NO // 当设置为YES时，将提取并生成私有类成员的文档。如果设置为NO，则不会生成私有成员的文档
EXTRACT_PACKAGE = NO // 当设置为YES时，将提取并生成 Java 中的包（package）级别类和函数的文档。如果设置为NO，则不会生成包级别成员的文档
EXTRACT_STATIC = NO        // 当设置为YES时，将提取并生成静态类成员的文档
EXTRACT_LOCAL_METHODS = NO // 当设置为YES时，将提取并生成局部（在函数内定义的）类和方法的文档
CALL_GRAPH = NO            // 当设置为YES时，将为每个函数生成一个调用关系图（call graph）
CALLER_GRAPH = NO          // 当设置为YES时，将为每个函数生成一个被调用关系图（caller graph）
RECURSIVE = NO             // 默认不会去递归整个文件树，而是只查找当前目录下的代码，把这个NO改成YES即可使doxygen递归整个文件树来查找代码。

NUM_PROC_THREADS = 1     // 限制 Doxygen 使用的线程数，默认1
DOT_NUM_THREADS = 0      // 用于控制在生成 Graphviz 图形（如调用关系图和被调用关系图）时使用的线程数，默认情况下，设置为0，这意味着根据您的计算机上的可用处理器核心数自动选择线程数
MAX_DOT_GRAPH_DEPTH = 0  // 限制生成的调用关系图和被调用关系图的深度。这可以防止陷入循环依赖导致的无限递归，默认为0
DOT_GRAPH_MAX_NODES = 50 // 用于设置生成的 Graphviz 图形（如调用关系图和被调用关系图）中的最大节点数。这个参数可以帮助您限制生成的图形的复杂性和大小。默认50

六、参考

https://zhuanlan.zhihu.com/p/122523174

https://mmdjiji.com/2021/10/2701/

https://blog.mythsman.com/post/5d29efa3cc343d1901c61cb3/