Mac OS X への Doxygen の導入

こんにちは。楷ノ木かえで です。やりたいことはタイトル通りです。

Doxygenとは

Doxygen とは、ソースコードにコメントを書くことでドキュメンテーションを自動生成するツールです。Python の docstring みたいなもんですかね(Pythonista並感)

インストール

Doxygen 公式 から Mac OS X 用の dmg をダウンロードしてインストール。

コマンドラインでも使えるようにするには、.bashrc に次を記述。

export PATH=/Applications/Doxygen.app/Contents/Resources/:$PATH

もしくは

sudo ln -s /Applications/Doxygen.app/Contents/Resources/doxygen /usr/local/bin

試用

Doxygen ファイルの生成

DoxygenGUI フロントエンドを開いて、Step 1 と書かれている部分に、ソースコードがあるディレクトリを設定します。

f:id:tenclaps:20140625065505p:plain

Step 2 の Wizard とか Expert とか書かれているタブでいろいろと設定できるのですが、とりあえずは初期設定のままでテストしてみましょう。

まずは今の設定を保存しましょう。メニューバーの File > Save から Doxygen ファイルを保存します。これにより設定した内容が次回以降も有効になります。次回は File > Open から Doxygen ファイルを選択しましょう。

Doxygen の実行

Run タブの Run doxygen を押すと doxygen が起動してドキュメントを生成します。初期設定では htmllatex ディレクトリを生成するはずです。

f:id:tenclaps:20140625065514p:plain

ディレクトリが生成されたら html/index.html をブラウザで開いてみましょう。何も書かれていないように見えますが、それは Main Page に出力する内容を何も設定していないからです。Classes と書かれているところをクリックすると、既存のクラスが表示されるはずです。

f:id:tenclaps:20140625065522p:plain

開いた先に、自分が書いたクラスが表示されていれば、とりあえず Doxygen はちゃんと動いていると確認できます。

Doxygen の文法など

今回の記事は導入までで終了しておきます。これだけでもクラスのリストが見られるので多少は有益ですが、Doxygen の本領はコード内にドキュメントを書き始めてはじめて発揮されると言えるでしょう。ドキュメントの記法は以下のようなページで見られるので参照してください。