最近看Palabos的代码时,发现官网的Developer’s Guide居然还在1.1版。于是生成了一个2.0版的代码文档。一些事情记录于本文。
更新:5.14 增加搜索框
为了方便分类,生成的Palabos代码文档的下载见下一篇博文。
1 Doxygen和Graphviz简介
Doxygen:Doxygen是一个自动代码文档生成的软件,如果代码的注释写的足够好的话,可以生成一个非常不错的代码文档。作为阅读代码的辅助工具甚好。
Graphviz:Graphviz是一个开源的图形可视化软件。这里负责辅助Doxygen生成代码关系图。比如类的继承图,如下图所示。

类的继承图
2 如何使用
- 参考 Developer_Kale的博文
注意:
- Doxygen的GUI运行程序是Doxywizard
- 除了图中设置外,大部分默认就行
- 别忘了指定Graphviz运行目录
- 完了可以save一下,这样配置项能得以保存
3 如何生成搜索框(5.14更新)
如图所示,采用保护导航栏的,可以正常生成搜索框:

设置

没有导航栏和搜索

有导航栏和搜索框
4 下载链接
提供Doxygen和Graphviz的下载链接: