Doxygen生成GPGPUSim v3项目代码文档

Doxygen生成GPGPUSim v3项目代码文档

本文主要介绍如何利用Doxygen可视化生成GPGPUSim v3的代码结构文档。
最后生成的html文档如下:
生成文档示例

1 下载安装Doxygen

Doxygen下载地址
在这里插入图片描述

2 填写相关的配置信息

关于可视化的代码部分,我们选择gpgpu-sim相关的,根据个人情况选择代码文档是否包括src/cuda-sim, src/gpuwattch, src/intersim2的部分。

选中的代码
配置信息:选择输入的代码文件夹位置和输出目录
在这里插入图片描述
在这里插入图片描述
根据个人情况选择输出文件类型
在这里插入图片描述

也可以在上一步选择docbook,这一步选择use dot tool fromt he GraphViz package的Diagrams生成类型,然后使用vscode 的插件graphviz可视化生成的dot文件,根据个人情况选择Dot graphs to generate 的参数,其中可以生成并查看复杂的类引用关系结构图。
在这里插入图片描述
在这里插入图片描述

在这里插入图片描述
配置Expert build下的参数,也可以根据自身情况进行选择。
在这里插入图片描述

3 生成文档

点击 RunRun doxygen,生成文档,点击Show HTML output,即可在浏览器查看生成的文档。在这里插入图片描述
在这里插入图片描述

最后其他类似的项目也可以根据代码生成类似的项目文档,适合分析代码逻辑和各个类结构的关系。非常好用!
参考的youtube视频 Doxygen Class Diagram and Document Auto generation from Code, #ClassDiagram #UML #Documentation

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值