phpDocumentorのメモ

PHPのソースからAPIドキュメントを出力するツール「phpDocumentor」を調べたのでメモ。
JavaでのJavaDocにあたるもの。PHPソース内の記述もJavaDocとほぼ同じ。

インストールはpearから。
-----インストール例-------
>pear install --alldeps phpdocumentor
WARNING: channel "pear.php.net" has updated its protocols, use "channel-update
ear.php.net" to update
downloading PhpDocumentor-1.4.2.tgz ...
Starting to download PhpDocumentor-1.4.2.tgz (2,421,028 bytes)
....................................................................done: 2,421
028 bytes
downloading XML_Beautifier-1.2.0.tgz ...
Starting to download XML_Beautifier-1.2.0.tgz (12,948 bytes)
...done: 12,948 bytes
downloading XML_Parser-1.3.2.tgz ...
Starting to download XML_Parser-1.3.2.tgz (16,260 bytes)
...done: 16,260 bytes
downloading XML_Util-1.2.1.tgz ...
Starting to download XML_Util-1.2.1.tgz (17,729 bytes)
...done: 17,729 bytes
install ok: channel://pear.php.net/PhpDocumentor-1.4.2
install ok: channel://pear.php.net/XML_Parser-1.3.2
install ok: channel://pear.php.net/XML_Util-1.2.1
install ok: channel://pear.php.net/XML_Beautifier-1.2.0

-----インストール例ここまで-------

実行はコマンドラインから。

(実行)
>phpdoc -t ドキュメント出力ディレクトリ -d ソースディレクトリ -o HTML:frames:earthli

※ 出力はHTML::frames:earthliがお気に入り

テーマ（？）のテンプレートが日本語対応になっておらず、出力したファイルが文字化けするので、以下のテンプレートを修正する。

ディレクトリ([php install directory]/data/PhpDocumentor/phpDocumentor/Converters/HTML/タイプ/templates/テーマ/templates)以下にあるheader.tplファイルのISO-8859-1と書かれている所を文字コードにあわせて修正

PDF/CHMもためしたが、PDFは文字化け、CHMはファイルの生成がされなかった。

[タイプ/テーマ]
frames（フレームあり）
　default
　DOM
　earthli
　l0l33t
　phpdoc.de
　phpedit
　phphtmllib

Smarty（フレームなし）
　HandS
　PHP
　default

(参考URL)
http://caspar.hazymoon.jp/php/phpDocumentor/