PHP
Doxygenは元々はC/C++用のドキュメント自動生成ツールでしたが、今はPHPのドキュメントも自動生成できます。
Graphvizと連携させることで、クラス継承図や関数呼び出しグラフを自動生成することができます。
http://onlineconsultant.jp/doxygen/wordpress-2.8.4-ja/d9/da1/inherit__graph__50.png” alt=”http://onlineconsultant.jp/doxygen/wordpress-2.8.4-ja/d9/da1/inherit__graph__50.png”>
http://onlineconsultant.jp/doxygen/wordpress-2.8.4-ja/d1/db9/class_p_h_p_mailer_a4a1f26533fba9015399ab2c0164a887a_cgraph.png” alt=”http://onlineconsultant.jp/doxygen/wordpress-2.8.4-ja/d1/db9/class_p_h_p_mailer_a4a1f26533fba9015399ab2c0164a887a_cgraph.png”>
Doxygenで生成されるドキュメントのサンプルとしては下記を参照してください。
Doxygenは元々静的言語用に開発されていたためか、動的に関数を追加する等、一部の静的に解釈できないコードはうまく処理できないようです。
Windows
以下はDoxygen 1.6.1で確認した内容になります。
インストール
- Graphvizは下記URLからダウンロードできます。
http://www.graphviz.org/
- Doxgenは下記URLからダウンロードできます。
http://www.doxygen.jp/
ドキュメント生成
doxygenにはDoxywizardというGUIツールが付属しており、それでドキュメント生成の設定を行うことができます。
作業ディレクトリの指定
Step 1:Specify the working directory from which doxygen will run
Doxygenの作業ディレクトリを指定します。
詳細設定
Step 2:Configure doxygen using the Wizard and/or Expert tab,
then switch to the Run tab to generate the documentation
Wizard/Expertタブで設定後、Runタブに切り替えて、ドキュメントを生成します。

プロジェクト名を入力します。
ソースコードのディレクトリを入力します。
指定したソースコードディレクトリ以下のサブディレクトリにあるファイルもドキュメント生成対象にします。
ドキュメントの出力先ディレクトリを入力します。

すべてのスクリプトがドキュメント生成対象になります。
- –Include cross-referenced source code in the output
自動生成ドキュメントにソースコードが含まれるようになります。
- –Optimize for C or PHP output
- -HTML
- –with frames and navigation tree
フレーム有りで、左側がナビゲーションツリーになります。

- –Use dot tool from the GraphViz package
GraphVizを利用してきれいな図を生成します。
- –Call graphs
- –Called by graphs
関数の呼び出しグラフを生成するようになります。

Japaneseを選択すると、ドキュメントの見出しが日本語になります。
ファイル一覧で、省略したい部分を指定します。
- Runタブ
- -Run Doxygenボタンで、ドキュメントの自動生成を開始します。
Linux
インストール
Red Hat系Linuxでは、yumでGraphViz/Doxygenをインストールすることができます。
# yum install graphviz
# yum install doxygen
ドキュメント生成
下記コマンドでドキュメントを生成します。
# doxygen 設定ファイルパス