phpDocumentorでドキュメントを生成してみる

PHP

CakePHPを設置してみる
の続き

phpDocumentorでドキュメントを生成してみる

インストール

下記の手順でインストールする。

$ sudo yum -y install php-pear php-xml
$ sudo pear channel-discover pear.phpdoc.org
$ sudo pear install -a phpdoc/phpDocumentor-alpha

生成

今回はcakephpのapp以下を生成してみる。

$ cd /var/www/html
$ phpdoc -d cakephp/app/ -t doc/

http://アドレス/doc/
にアクセスすると、下記のように表示される。

テンプレートの指定

--templateオプションでテンプレート指定できる。

指定できるテンプレートはtemplate:listで確認できる。

$ phpdoc template:list
Available templates:
* responsive-twig
* xml
* zend
* new-black
* abstract
* responsive
* checkstyle
* old-ocean
* clean

一旦削除し、
responsiveテンプレートを指定してみる。

$ rm -rf doc/
$ phpdoc -d cakephp/app/ -t doc/ --template responsive

下記のように表示される。