PHP Evo

phpDocumentorのインストール

1. phpDocumentorとは

1.1 phpDocumentorとは何か

phpDocumentorとは、PHPのソースファイルからドキュメントを作成するツールです。
形式はJavaDocと似た形式であるphpDocコメントからドキュメントを生成します。phpDocについては、phpDocumentorのホームページを参照してください。

1.1 phpDocumentorを手に入れる

phpDocumentorは、Sourceforgeから手に入れることができます。
Project: phpDocumentorのページからダウンロードのリンクをクリックし、アーカイブファイルをダウンロードしてください。

2. phpDocumentorをインストールする

2.1 ファイルの展開、インストール

適当なディレクトリにアーカイブファイルを展開し、phpdocを実行パスにコピーします。。

  1. cd /usr/local
  2. tar zxvf phpdoc-1.1.0rc2.tar.gz
  3. mv phpdoc-1.1.0rc2 phpdoc
  4. cp /usr/local/phpdoc/phpdoc /usr/local/bin

2.2 ファイルのカスタマイズ

展開したディレクトリにあわせ、ファイルを次のように変更します。

Converter.inc 
1739:		$this->templateDir = "/usr/local/phpdoc/Converters/" . $this->outputformat . "/" . $this->name . "/templates/" . $dir;
Errors.inc 
215 : PDEXCEPTION_FILENOTFOUND => 'rare encounter of bug 564174, no linkswithfile for file in Converter::get*Link()',
phpdoc.inc 
308 : $render->addConverter('HTML', 'default', 'default/');
/usr/local/bin/phpdoc 
37  : include("/usr/local/phpdoc/phpdoc.inc");

以上でインストールは終了です。

もどる