phpDocumentorの設定

お家のMac(Lion)にphpDocumentorを入れる。

モチベーションは、今までしていたExcelでの家計管理。
基本的にはカードの明細のExcelをもとに関数を使っていろいろしていたけど手作業が多いので、システムにしたいな〜という所から。

phpで作ろうとしているけど、まじめにドキュメントを書こうと思ってphpDocumentorを入れてみることにした。

pearをインストールして、次のコマンドをタイプするとさくっとインストール完了。

sudo pear install phpdocumentor


ここで、次のコードをタイプするとできる、と書かれているサイトが多い。

phpdoc -t ./doc -d ./src -o HTML:Smarty:PHP


私の場合は下記のようなエラーが。

PHP Warning: require(PhpDocumentor/phpDocumentor/phpdoc.inc): failed to open stream: No such file or directory in /usr/bin/phpdoc on line 40
PHP Fatal error: require(): Failed opening required 'PhpDocumentor/phpDocumentor/phpdoc.inc' (include_path='.:/') in /usr/bin/phpdoc on line 40

とりあえず、php.iniの中で、インクルードパスに

include_path='.:/usr/lib/php'

を設定すればいいと書いてあるサイトを発見したけど、またほぼ同じエラーメッセージが。

PHP Warning: require(PhpDocumentor/phpDocumentor/phpdoc.inc): failed to open stream: No such file or directory in /usr/bin/phpdoc on line 40
PHP Fatal error: require(): Failed opening required 'PhpDocumentor/phpDocumentor/phpdoc.inc' (include_path='.:/usr/lib/php') in /usr/bin/phpdoc on line 40

どうやらデフォルトだとphpDocumentorが/usr/lib/php/phpDocumentor....と配置されるらしいので、include_pathを設定すれば動くはずとのこと。
配置された場所が怪しいと思い、/usr/lib/phpにphpDocumentorがあるか探してみたところ、やっぱりphpDocumentorはなかった。周辺を探してみると、/usr/lib/php/pearにあった。

なので、結局はphp.iniに、

include_path='.:/usr/lib/php/pear'

を設定して、無事動かすことが出来ました。



ついでにExtJSっぽいテンプレートを設定。
参考:http://www.onigoetz.ch/2010/09/11/new-theme-for-phpdocumentor/
私の環境では置き場所は下記でした。

/usr/lib/php/pear/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/Evolve
/usr/lib/php/pear/data/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/Evolve