O'Reilly logo

PHP 5 Power Programming by Derick Rethans, Stig Sæther Bakken, Andi Gutmans

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

B.5. Using the phpDocumentor Tool

You need the phpDocumentor tool to generate the documentation from the sources enhanced with the tags from the previous section. This tool is installed along with some templates when you type pear install phpDocumentor. The tool has several parameters that are listed in Table B.2. phpdoc -h gives you a full overview of parameters; here the most important are described:

Table B.2. phpDocumentor Tool Parameters
OptionCommentsExample
-f, --filenameComma-separated list of files to parse. You can use the wildcards * and ?.-f index.php,index2.php
-d, --directoryComma-separated list of directories to parse, with the same wildcards supported as with -f.-d lib*,core
-ed, --examplesdirFull path to the directory with examples. ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required