Class parserSeeTag

Description

represents the "@see" tag

Located in /phpDocumentor/DocBlockTags.inc (line 704)

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserLinkTag
            |
            --parserSeeTag
Direct descendents
Class Description
parserUsesTag represents the "@uses" tag
parserTutorialTag represents "@tutorial"
Variable Summary
string $keyword
Method Summary
parserSeeTag parserSeeTag (string $name)
string Convert (Converter &$converter)
Variables
string $keyword = 'see' (line 710)

always 'see'


Redefinition of:
parserLinkTag::$keyword
always 'link'

Redefined in descendants as:

Inherited Variables

Inherited from parserTag

parserTag::$type

Inherited from parserStringWithInlineTags

parserStringWithInlineTags::$value
Methods
Constructor parserSeeTag (line 717)

sets up the see tag

parserSeeTag parserSeeTag (string $name)
  • string $name: element to link to
Convert (line 731)

process this tag through the given output converter

string Convert (Converter &$converter)
  • Converter &$converter: the output converter

Redefinition of:
parserTag::Convert()
Perform the output conversion on this parserTag using the output converter that is passed in

Redefined in descendants as:

Inherited Methods

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:15:10 -0600 by phpDocumentor 1.4.4