phpDocumentor

しばらくぶりにサイトを見たら新しいphpDocumentor2が出ていたのでインストールして試してみました。

バージョン2になると、高速化、テンプレートシステム、レポート、チャート機能といった特徴があるようです。

環境

セットアップ環境は下記の通りです。

  • Ubuntu10.04
  • PHP 5.3.2-1ubuntu4.14

セットアップ

PHPのXSLモジュールが必要とのことでインストール。

<br />
$ sudo apt-get install php5-xsl<br />

phpDocumentorをインストール。

<br />
$ pear channel-discover pear.phpdoc.org<br />
$ pear install phpdoc/phpDocumentor<br />

エラーが出ました。

<br />
Failed to download phpdoc/phpDocumentor within preferred state &quot;stable&quot;, latest release is version 2.0.0a1, stability &quot;alpha&quot;, use &quot;channel://pear.phpdoc.org/phpDocumentor-2.0.0a1&quot; to install<br />
install failed<br />

バージョンを明示して再度インストール。

<br />
$ sudo pear install phpdoc/phpDocumentor-alpha<br />

これでインストールできたので、ドキュメントを生成してみます。

<br />
$ phpdoc run -d /path/to/source -t /path/to/output<br />

こんな感じでファイルが作られました。

<br />
$ ls /path/to/output<br />
classes  css  deprecated.html  errors.html  graph_class.html  img  index.html  js  markers.html  namespaces  packages  structure.xml<br />

あとはindex.htmlをブラウザで開いて参照できます。

phpDocumentor2

デフォルトのテンプレートはこんな感じの画面レイアウトです。何か見たことあるなあ、と思ったらTwitter BootStrap使ってるみたいですね。

phpDocumentor

ちなみに、メニュー>Charts>Class hierarchy diagram にアクセスするとロード中のまま表示されませんでした。

phpDocumentor