phpdocumentor cheat sheet

Published: 11/16/2008

Programming

I’ve been documenting my code in phpdoc style for a while and have compiled a cheat sheet of common tasks and cheats.

To process a given directory use the following:

phpdoc -o HTML:frames:default, HTML:Smarty:PHP, HTML:frames:phpedit, PDF:default:default, CHM:default:*, HTML:frames:phphtmllib, HTML:frames:l0l33t, HTML:frames:earthli -t /Path/To/Storage/Directory -d/Path/To/Directory/To/Parse

For a full outline of all available command options

A list of default tags:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

* @abstract
* @access       public or private
* @author       author name <author@email>
* @copyright    name date
* @deprecated   description
* @deprec       alias for deprecated
* @example      /path/to/example
* @exception    Javadoc-compatible, use as needed
* @global       type $globalvarname
or
* @global       type description of global variable usage in a function
* @ignore
* @internal     private information for advanced developers only
* @param        type  description
* @return       type description
* @link         URL
* @name         procpagealias
or
* @name         $globalvaralias
* @magic        phpdoc.de compatibility
* @package      package name
* @see          name of another element that can be documented,
*                produces a link to it in the documentation
* @since        a version or a date
* @static
* @staticvar    type description of static variable usage in a function
* @subpackage    sub package name, groupings inside of a project
* @throws       Javadoc-compatible, use as needed
* @todo         phpdoc.de compatibility
* @var        type    a data type for a class variable
* @version    version