Description
parserBase | --parserStringWithInlineTags | --parserTag | --parserLinkTag | --parserSeeTag | --parserUsesTag
Located in File: /phpDocumentor/DocBlockTags.inc
represents the "@uses" tag
This is exactly like @see except that the element used has a @useby link to this element added to its docblock
- tutorial: - @uses
- author: - Greg Beaver <[email protected]>
- version: - Release: @VER@
- copyright: - 2002-2008 Gregory Beaver
- link: - http://pear.php.net/PhpDocumentor
- link: - http://www.phpdoc.org
- todo: - CS cleanup - change package to PhpDocumentor
- todo: - CS cleanup - change classname to PhpDocumentor_*
- since: - 1.2
- license: - LGPL
Classes extended from parserUsesTag:
- parserUsedByTag
- This is a virtual tag, it is created by @uses to cross-reference the used element
$keyword = 'uses' (line Class Constants
Summary:Method Detail
Summary:
Constructor parserUsesTag (line 857)
parserUsesTag parserUsesTag( string $seeel, parserStringWithInlineTags $description)
set up the uses tag
Parameters
- string $seeel: element to link to
- parserStringWithInlineTags $description: description of how the element is used
Info
Method Convert (line 879)
string Convert( Converter &$c)
Overridden in child classes as:
- parserUsedByTag::Convert()
- process this tag through the given output converter
Overrides : parserSeeTag::Convert() process this tag through the given output converter
Return a link to documentation for other element, and description of how it is used
Works exactly like parent::Convert() except that it also includes a description of how the element used is used.
Parameters
- Converter &$c: the output converter
Info
- return - link to the uses target
- todo - CS cleanup - rename to convert for camelCase rule
Method getDescription (line 908)
parserStringWithInlineTags getDescription( )
Get the description of how the element used is being used.
Info
- usedby - phpDocumentor_IntermediateParser::addUses() - used to initialize $uses