PHPXrefを使う
PHPのソースからドキュメントを生成してくれるPerlスクリプトでPHPXref - The PHP Cross Referencing Documentation Utilityというものがある.ソース表示するとJavaScriptなんかで関係のあるものを表示してくれたりして,ソース追っかけるときに便利なので使用してみた.以下導入およびドキュメント生成手順.
まずソース落としてきて解凍する.
$ wget "http://prdownloads.sourceforge.net/phpxref/phpxref-0.7.tar.gz?download" $ tar xzf phpxref-X.X.tar.gz
つぎに生成元となるソースと,ドキュメントの生成先となるディレクトリおよび文字エンコーディングを指定する.他にも設定できる項目はあるが,とりあえず基本的なものだけ.
$ vi phpxref.cfg // 設定ファイル --以下適切な内容に書き換える. SOURCE=/home/hoge/php_src // 生成元となるソースを置いているディレクトリを指定する. OUTPUT=/home/hoge/php_doc // ドキュメントの生成先となるディレクトリを指定する. CHARSET=UTF-8 // 適切なエンコードを指定する.今回はUTF8なソースだったのでUTF8を.
ドキュメントの生成は,phpxref.pl を実行する.
$ ./phpxref.pl