B.4. Tag Table

Table B.1 shows an overview of where the tags as described in this appendix might be used. An X marks that a specific tag might be used to document and element, an M specifies that it is mandatory to use that tag to document the element.

Table B.1. Tag Table
TagGlobal VarIncludeConstantFunctionDefineClassVariableMethodPage
AccessXXXXXXXXX
AuthorXXXXXXXXX
CopyrightXXXXXXXXX
DeprecatedXXXXXXXXX
ExampleXXXXXXXXX
IgnoreXXXXXXXXX
internalXXXXXXXXX
LinkXXXXXXXXX
link (inline)XXXXXXXXX
seeXXXXXXXXX
sinceXXXXXXXXX
tutorialXXXXXXXXX
versionXXXXXXXXX
nameX   X    
globalM  X   X 
param   X   X 
return   X   X 
staticvar      X  
package     X  X
subpackage     X  X
static     X X 
inline {@source}   X   X 
inline {@inheritdoc}     XXX 
abstract     XXX 
filesource ...

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.