Doxygen【インストール+OpenFOAM・FrontISTR】
Doxygenを使ってソースコードを確認します。インストールはこちら。
$ sudo apt-get install doxygen graphviz
参考にしました。
OpenFOAMのドキュメント化
OpenFOAMのソースコード中の、Doxygenのディレクトリを引っ張ってきます。ドキュメントができるには結構時間がかかります。(数時間程度?)
$ cp -r $WM_PROJECT_DIR/doc/Doxygen/* . $ cd Doxygen $ ./Allwmake
参考にしました。
PENGUINITIS - Doxygen ドキュメントの生成と参照
FrontISTRのドキュメント化
cmakeでコンパイルする際にオプションをつけるようです。
-DWITH_DOC=ON
https://frontistr-commons.gitlab.io/FrontISTR/manual_ja/install/install_ja.pdf
らしいですが、自分の場合はautofistrを使っていたので、上の手順はふまず、autofistrのMakefileをいじることにします。
FrontISTRのインストールにautofistrを使用した時のメモ - Qiita
とりあえず、いったんmake cleanをかけます。
$ make clean
Makefileの中を修正します。 -D WITH_DOC=0を1に。
965 -D WITH_DOC=1 \
早速、makeします。
$ make
コンパイルが完了したら、FrontISTRのディレクトリに移動。そのまま、buildのフォルダに移動し、make docをたたきます。結構時間がかかります(数時間程度?)
$ cd build $ make doc
htmlファイルができているので、確認します。
$ ls doc/html/index.html
結局ドキュメントは見れたの?
現状見れていない!のです。。。htmlを見るためにfirefoxをインストールしようとして苦戦しているのです。「激闘firefoxインストール編」に続く。