This repository has been archived by the owner on May 26, 2021. It is now read-only.
forked from msroot/vanity
-
Notifications
You must be signed in to change notification settings - Fork 0
PHPDoc tags
skyzyx edited this page Oct 31, 2012
·
20 revisions
Vanity strives to match the behavior of the draft-quality PHPDoc PSR proposal. In places where the documentation for a given tag is incomplete, Vanity aims to adhere to the classic phpDocumentor manual for compatibility reasons.
NOTE: It is important to clarify that PHPDoc is the name of the de-facto standard for annotating DocBlocks in PHP source code. phpDocumentor, by contrast, is the name of a documentation generation tool.
Vanity comprehends the following PHPDoc tags (not all are used in the default template):
- @alias
- @api
- @author
- @copyright
- @deprecated (alias: @depreciated)
- @event (alias: @dispatches)
- @example
- {@example [URI] [:<start>..<end>]} (inline)
- @global
- @internal
- {@internal [description]} (inline)
- @license
- @link
- {@link [URI] [description]} (inline)
- @method
- @package
- @param
- @property (alias: @property-read, @property-write)
- @return (alias: @returns)
- @see
- {@see [type] [description]} (inline)
- @since (alias: @available)
- @throws (alias: @throw)
- @todo (alias: @fixme)
- @uses (alias: @used-by)
- @type (alias: @var [deprecated])
- @version
NOTE: Nested internal tags are not presently supported.
- @author — Adds support for the service shortcuts.
- @license — Adds support for SPDX license shortcuts.
- @link — Adds support for the service shortcuts.
These tags have been deprecated or removed from the specification, and are not supported by Vanity.
- @category
- @filesource
- @final
- @ignore
- @subpackage