Docs For Class parserSeeTag

Description

represents the "@see" tag

tutorial: @see
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.0rc1
license: LGPL

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:

parserUsesTag::$keyword : Always "uses"
parserUsedByTag::$keyword : Always "usedby"
parserTutorialTag::$keyword : Always "tutorial"

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

return: converted value of the tag
see: parserStringWithInlineTags::Convert()
todo: CS cleanup - rename to convert for camelCase rule

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:

parserUsesTag::Convert() : Return a link to documentation for other element, and description of how it is used
parserUsedByTag::Convert() : process this tag through the given output converter
parserTutorialTag::Convert() : process this tag through the given output converter

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()