SU2代码文档编译

SU2并没有直接提供代码文档，需要利用Doxygen自行编译。Doxygen编译文档的过程比较简单，可以按照下面的步骤完成编译过程。

1、下载SU2源代码

从SU2官网直接下载（https://su2code.github.io/download.html）源代码。如下图所示，将Source.zip文件下载到本地并解压。

2、安装doxygen

Ubuntu下利用命令安装doxygen和graphviz：

sudo apt install doxygen
sudo apt install graphviz

这里doxygen用于生成文档，graphviz用于绘制类图。如果不按照graphviz，则无法绘制类图。

3、编译文档

在Ubuntu下利用cd命令进入到SU2的根目录，运行下面的命令进行文档编译：

doxygen

编译过程极其缓慢，可能要持续十多分钟。

编译完毕后终端如下图所示。

文档编译完毕后，在SU2根目录下的Docs文件夹中会出现一个名为html文件夹。

在html文件夹中找到文件 index.html 。

打开后即可看到SU2的代码文档。

这里要吐槽一下SU2的文档，真心烂啊有没有，原本以为OpenFOAM的文档已经够烂了，这货的文档居然能够比OpenFOAM更烂，那些说“程序代码就是最好的文档“的人，绝对是天底下最不负责任的人。