Doxygen生成GPGPUSim v3项目代码文档
本文主要介绍如何利用Doxygen
可视化生成GPGPUSim v3
的代码结构文档。
最后生成的html文档如下:
1 下载安装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 生成文档
点击 Run
下Run doxygen
,生成文档,点击Show HTML output
,即可在浏览器查看生成的文档。
最后其他类似的项目也可以根据代码生成类似的项目文档,适合分析代码逻辑和各个类结构的关系。非常好用!
参考的youtube视频 Doxygen Class Diagram and Document Auto generation from Code, #ClassDiagram #UML #Documentation