phpDocumentor Manual | ||
---|---|---|
Prev | Next |
phpDocumentor written by:
Joshua Eichorn <jeichorn@phpdoc.org>
Kellin <passionplay@hotmail.com>
Juan Pablo Morales <ju-moral@uniandes.edu.co>
Florian Clever <fclever@verinform.com>
Dennis Kehrig <TheGeek@web.de>
Greg Beaver <cellog@users.sourceforge.net>
Tag Documentation written by Gregory Beaver <cellog@users.sourceforge.net>
Copyright © 2002, Gregory Beaver
Welcome to the phpDocumentor Manual! Please refer to the HOWTO for an overview of the usage of phpDocumentor.
phpDocumentor HOWTO
phpDocumentor Converter HOWTO
phpDocumentor Template HOWTO
Tag Reference
@package Document a collection of elementsTemplate Reference
@subpackage Document a sub-collection of elements
@access Specify whether an element should be parsed or not
@ignore ignore an element
@version Display version information for an element
@author Display author information
@copyright Display Copyright information
@since Display Information on which version an element was introduced to a project
@deprecated Deprecate an element
@return Describe the return value of a function
@var Document the data type of a class variable
@param Describe a parameter of a function
@global Document global variable definition or use
@staticvar Document static variable use in a function
@name Set an alias for a procedural page or global variable
@link Display a hyperlink
@see Display a link to an element's documentation
inline {@link} Display a hyperlink or a link to an element's documentation in the natural text flow
inline {@id} Used to control XML package page ids in refsects
inline {@inheritdoc} Used to directly inherit the long description from the parent class in child classes
inline {@source} Display highlighted source code of a function, complete or an excerpt
Primary files:
index.html Primary HTML page with framesets
packages.html upper left corner, package lists
left.html lower left corner, package index, list of elements
elementindex.html Index of all documented elements
pkgelementindex.html Index of all documented elements arranged by package
classtrees.html class trees, by package
page.html Procedural page template
class.html Class template
errors.html Error Log template
Repetitive files, may be directly included in Primary files or included using <include>
constants_summary.inc.html Summary of Defines
globals_summary.inc.html Summary of Global Variables
functions_summary.inc.html Summary of Functions
includes_summary.inc.html Summary of Included files
vars_summary.inc.html Summary of Class Variables in a Class
constants_detail.inc.html Detail of Defines
functions_detail.inc.html Detail of Functions or Class Methods
includes_detail.inc.html Detail of Included files
globals_detail.inc.html Detail of Global Variables
vars_detail.inc.html Detail of Class Variables
docblock.inc.html Documentation Block for non-functions/non-methods
docblock-func.inc.html Documentation Block for functions/methods
functions_inherited.inc.html Summary of Inherited Functions for a child class
vars_inherited.inc.html Summary of Inherited Variables for a child class
pagefoot.inc.html footer of any page you wish (optional)
pagetop.inc.html top of any page you wish (optional)
Prev | Home | Next |
Up | Tags |