生成的Doxygen文档允许使用者快速地查找相关类的信息。Doxygen文档系统生成可以使用Web浏览器浏览的HTML文档,其优点是可以查看带有链接元素的类图和协作图。这使得在研究类和算法之间的交互时特别有用。与使用文本编辑器浏览源代码相比,在HTML浏览器中跟踪指向基类的链接对大多数读者来说可能更有效。或者在使用OpenFOAM时,可以使用集成开发环境(IDE)浏览源代码。要开始学习OpenFOAM,我们推荐使用文本编辑器和Doxygen生成的文档。对于OpenFOAM新手来说,设置IDE以使用OpenFOAM本身可能是一项复杂的任务。

为了生成文档,需要在文件夹$WM_PROJECT_DIR/doc中执行命令Allwmake

当Doxygen执行完毕后,可以利用浏览器打开文件$WM_PROJECT_DIR/doc/Doxygen/html/index.html

此页面是OpenFOAM安装的本地生成HTML帮助的起始页面。或者也可以使用基于LaTeX的文档,该文档以PDF格式提供,但必须手动转换。

练习:利用Doxygen源代码文档查询并了解tmp<Type> 智能指针的类型是什么?