Doxygen ドキュメントの生成と参照

2014年2月16日

はじめに

Doxygen ドキュメントの生成と参照について。

使用バージョン

OpenFOAM 2.2.2

Doxygen ドキュメント

境界条件の設定方法などの情報は、ユーザーズガイドにはほとんど記述がなく、ソースコードを参照することになる。さいわい、ソースコードのコメントは Doxygen 形式で記述されており、Doxygen によりきれいに整形されたドキュメントを生成することができる。ソースコードを直接参照するよりはずっと読みやすい。

Doxygen ドキュメントの生成

まず、システムに doxygen と graphviz がインストールされていることを確認する。よくわからなければインストールしてみればよい。

$WM_PROJECT_USER_DIR ディレクトリがなければ作る。

$ mkdir -p $WM_PROJECT_USER_DIR

Doxygen ディレクトリの中身を丸ごとコピーする。

$ cp -r $WM_PROJECT_DIR/doc/Doxygen/* $WM_PROJECT_USER_DIR

移動。

$ cd $WM_PROJECT_USER_DIR

設定ファイル Doxyfile を必要に応じて修正する。

MAX_DOT_GRAPH_DEPTH    = 1

これはクラスの継承図の深さの指定で、公式はどうやら 2 で出力されている。これを 0 に設定すると、継承をすべて描画する。ソースコードの解析を行いたい場合は 0 を指定したほうが便利かもしれない。

変換を実行する。

$ ./Allwmake

そこそこ時間がかかる。処理が完了したら、"html" というディレクトリができている。その中の "index.html" をブラウザで開けば、Doxygen ドキュメントを参照できる。

$ firefox html/index.html

境界条件のドキュメントの表示

foamHelp で境界条件のドキュメントを表示させることができる。ケースディレクトリの中で実行する。

あるフィールドファイルで指定できる境界条件を表示するには、つぎのようにする。

$ foamHelp boundary -field U
Selecting helpType boundary

...

Available boundary conditions for vector field: U
    SRFFreestreamVelocity
    SRFVelocity
    activeBaffleVelocity
    activePressureForceBaffleVelocity
    advective
    ...

つぎのように実行すると、境界条件の Doxygen ドキュメントがブラウザで表示される。

$ foamHelp boundary -browse advective

function object の情報も表示できる。

$ foamHelp functionObject

...

Valid types include:

74
(
CloudFunctionObject
CloudFunctionObjectList
CourantNo
DESModelRegions
FacePostProcessing
...

たとえば、fieldAverage のドキュメントを表示するには、つぎのようにする。

$ foamHelp functionObject -browse fieldAverage