当项目文件极为庞大时,为了便于自己或他人进行整个项目文件框架的梳理,生成doxygen文件是非常必要的,它能对项目的框架自动进行分析,生成不同模块甚至函数间的调用逻辑关系图。尤其在团队开发的时候是极为重要且必要的。
生成doxygen的方法非常简单,我们需要两个工具就可以完成,分别是graphviz和doxygen。
1.Linux工具安装
linux下安装这两个工具非常简单,两句命令即可完成,不需要进行其余操作。
sudo apt install graphviz
sudo apt install doxygen
2.进入项目文件根目录
从终端进入想要生成doxygen文档的项目目录下,为了便于查看,可以实现创建一个生成文件的存放目录,方便后续查看。
mkdir doxygen
3.生成配置文件
不要进入刚刚新建的存放目录,回到刚才想要生成doxygen文档的项目目录,输入生成配置文件的命令语句。
doxygen -g Doxygen.config
4.配置文件
进入配置目录进行文件配置。
vim Doxygen.config
在配置文件中对下方的选项进行更改,“HAVE_DOT”选项一般默认为YES,可以确认一下。“OUTPUT_DIRECTORY”填写刚刚生成的存放文件目录。
更改方法,按“i”进行“INSERT”状态,对文件进行更改,完成所有更改后按“:”后按“wq” 退出状态。
EXTRACT_ALL = YES
HAVE_DOT = YES
UML_LOOK = YES
RECURSIVE = YES
CALL_GRAPH = YES
CALLER_GRAPH = YES
TEMPLATE_RELATIONS =YES
UML_LIMIT_NUM_FIELDS = 30
OUTPUT_DIRECTORY =
5.生成运行
开始生成文件,时间根据文件大小不一,安心等待即可。
doxygen Doxygen.config
6.生成目录
完成后即可在刚才新建的存放目录下找到latex和html两个子文件夹,html文件内部有各级别的函数的调用关系,根据自身需求使用即可。