phpDocumentor - ドキュメント生成の実行

ドキュメントの生成はコマンドラインから行う。

書式

[php実行ファイル] [phpdocファイル] [オプション]

例（ヘルプの表示）

php phpdoc -h

例（ドキュメントの生成）

php phpdoc -t doc -d src

例（うちのWindows環境）

"c:\php\php.exe" "c:\phpDocumentor\pear-phpdoc" -t ./doc/ -

指定できるオプション

-hオプションを与えてphpdocを実行すると,利用可能なオプションの一覧が表示される。

PhpDocumentor-1.3.0RC4のヘルプコマンドより抜粋

  -f    --filename
  -d    --directory
  -ed    --examplesdir
  -tb    --templatebase
  -t    --target
  -i    --ignore
  -it    --ignore-tags
  -dh    --hidden
  -q    --quiet
  -ti    --title
  -h    --help
  -c    --useconfig
  -pp    --parseprivate
  -po    --packageoutput
  -dn    --defaultpackagename
  -dc    --defaultcategoryname
  -o    --output
  -cp    --converterparams
  -ct    --customtags
  -s    --sourcecode
  -j    --javadocdesc
  -p    --pear
  -ric    --readmeinstallchangelogSpecify

左側が省略されたオプションで、右側の文字列が正式なオプション名である。
「phpdoc -h」と「phpdoc --help」は同様に扱われる。

ドキュメント出力ディレクトリの指定 -t(--target)

書式

phpdoc -t [ドキュメントを出力するディレクトリ（相対パスor絶対パス）]

例

phpdoc -t ./doc/

ソースファイルが格納されているディレクトリを指定 -d (--directory)

書式

phpdoc -d [ソースファイルが格納されているディレクトリ（相対パスor絶対パス）]

例

phpdoc -d ./src/

ソースファイルを直接指定 -s (--sourcecode)

書式

phpdoc -s [ソースファイル（複数の場合はカンマで区切る）]

例

phpdoc -s ./src/user.php, ./src/master.php

ドキュメントに表示されるタイトルを指定 -ti(--title)

書式

phpdoc -ti [タイトル]

例

phpdoc -ti "Hello"

テンプレートの指定 -o(--output)

あらかじめ用意されているテンプレートは、phpDocumentorフォルダ内のphpDocumentor/Converters/以下に格納されている。
デフォルトで指定できるテンプレートの一覧は以下の通りである。

HTML:default:default（デフォルト）
HTML:frames:default
HTML:frames:l0l33t
HTML:frames:phpdoc.de
HTML:frames:phphtmllib,
HTML:frames:earthli,
HTML:frames:DOM/default
HTML:frames:DOM/l0l33t
HTML:frames:DOM/phpdoc.de,
HTML:frames:DOM/phphtmllib
HTML:frames:DOM/earthli
HTML:Smarty:default
HTML:Smarty:PHP
HTML:Smarty:HandS
PDF:default:default
CHM:default:default
XML:DocBook/peardoc2:default

書式

phpdoc -o [テンプレート]

例

phpdoc -o HTML:default:default

テンプレートのいろいろな例 phpdoc -o HTML:default:default -d ./src/ -t ./doc/
（未指定phpdoc -d ./src/ -t ./doc/と同じ）

図1：HTML:default:default

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

図2：HTML:Smarty:default

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

図3：HTML:Smarty:PHP

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

図4：HTML:Smarty:HandS

phpdoc -o PDF:default:default -d ./src/ -t ./doc/

図5：PDF:default:default