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. ...

Get PHP 5 Power Programming now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.