Skip to content

Latest commit

 

History

History
73 lines (55 loc) · 2.94 KB

DOCBLOCK.md

File metadata and controls

73 lines (55 loc) · 2.94 KB

All documentation identifers, may be line or block base: line: @author Jason P. Scharf block: @author Jason P. Scharf John Doe @end_author

@function

@version - Desc: Version of current element - Ref: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.version.pkg.html

@author - Desc: Author of current element - Ref: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.author.pkg.html

@category - Desc: Specify a category to organize the documented element's package into - Ref: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.category.pkg.html

@copyright - Desc: Document Copyright information - Ref: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.copyright.pkg.html

@deprecated - Desc: Document elements that have been deprecated and should not be used as they may be removed at any time from a future version - Ref: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.deprecated.pkg.html

@example - Desc: Include an external example file with syntax highlighting - Ref: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.example.pkg.html

@license - Desc: Display a hyperlink to a URL for a license - Ref: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.license.pkg.html

@link - Desc: Display a hyperlink to a URL in the documentation - Ref: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.link.pkg.html

@package - Desc: Specify package to group classes or functions and defines into - Ref: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.package.pkg.html

@param - Desc: Document a function parameter - Ref: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.param.pkg.html

@return - Desc: Specify the return type of a function or method - Ref: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.return.pkg.html

@since - Desc: Document when (at which version) an element was first added to a package - Ref: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.since.pkg.html

@subpackage - Desc: Specify sub-package to group classes or functions and defines into. Requires @package tag - Ref: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.subpackage.pkg.html

@todo - Desc: Document changes that will be made in the future - Ref: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.todo.pkg.html

@uses - Desc: Display a link to the documentation for an element, and create a backlink in the other element's documentation to this - Ref: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.uses.pkg.html

@var