Class parserUsesTag

Description
Direct descendents
Class Description
parserUsedByTag This is a virtual tag, it is created by @uses to cross-reference the used element
Variable Summary
string $keyword
Method Summary
parserUsesTag parserUsesTag (string $seeel, parserStringWithInlineTags $description)
string Convert (Converter &$c)
Variables
string $keyword = 'uses' (line 844)

Always "uses"


Redefinition of:
parserSeeTag::$keyword
always 'see'

Redefined in descendants as:

Inherited Variables

Inherited from parserTag

parserTag::$type

Inherited from parserStringWithInlineTags

parserStringWithInlineTags::$value
Methods
Constructor parserUsesTag (line 857)

set up the uses tag

parserUsesTag parserUsesTag (string $seeel, parserStringWithInlineTags $description)
Convert (line 879)

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.

  • return: link to the uses target
  • todo: CS cleanup - rename to convert for camelCase rule
string Convert (Converter &$c)

Redefinition of:
parserSeeTag::Convert()
process this tag through the given output converter

Redefined in descendants as:
getDescription (line 908)

Get the description of how the element used is being used.

parserStringWithInlineTags getDescription ()

Inherited Methods

Inherited From parserSeeTag

parserSeeTag::parserSeeTag()
parserSeeTag::Convert()

Inherited From parserLinkTag

parserLinkTag::parserLinkTag()

Inherited From parserTag

parserTag::parserTag()
parserTag::Convert()
parserTag::getString()
parserTag::HandleEvent()

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::add()
parserStringWithInlineTags::Convert()
parserStringWithInlineTags::getString()
parserStringWithInlineTags::hasInlineTag()
parserStringWithInlineTags::setSource()
parserStringWithInlineTags::trimmedStrlen()

Inherited From parserBase

parserBase::getType()
parserBase::getValue()
parserBase::setValue()

Documentation generated on Mon, 05 Dec 2011 21:20:48 -0600 by phpDocumentor 1.4.4