May 18, 2013

ApiGenでFuelPHPのドキュメントを生成してみる

FuelPHPはほとんど関係ありませんが、ネタとして。

ApiGenでPHPドキュメントが作成出来ます。
http://apigen.org/
https://github.com/apigen/apigen

PEARでインストールしてみます。
$ pear config-set auto_discover 1
$ pear install pear.apigen.org/apigen
FuelPHPのルートで以下を実行してみます。
$ apigen -s fuel/core/ -d apigen
ApiGen 2.8.0
------------
Scanning /xxx/fuelphp-1.6/fuel/core
[===============================================================>] 100.00%  34MB
Found 264 classes, 0 constants, 38 functions and other 19 used PHP internal classes
Documentation for 264 classes, 0 constants, 38 functions and other 19 used PHP internal classes will be generated
Using template config file /Applications/MAMP/bin/php/php5.4.4/lib/php/data/ApiGen/templates/default/config.neon
Generating to directory apigen
[===============================================================>] 100.00%  88MB
Done. Total time: 2 min 28 sec, used: 91 MB RAM
* -sでターゲットディレクトリ、-dで出力ディレクトリを指定しています。
* 結構時間がかかりました。

apigen/index.htmlに、ブラウザからアクセスしてみます。

phpDocumentor 2より楽だなー。

--

関連:
phpDocumentor 2のインストール手順(Mac/Win/Linux)
http://madroom-project.blogspot.jp/2012/12/phpdocumentor-2macwin.html

No comments:

Post a Comment