Class parserSeeTag

(line 704)

Description

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserLinkTag
            |
            --parserSeeTag

Located in File: /phpDocumentor/DocBlockTags.inc

represents the "@see" tag


Classes extended from parserSeeTag:
parserUsesTag
represents the "@uses" tag
parserTutorialTag
represents "@tutorial"

Class Variables

Summary:
string $keyword

$keyword = 'see' (line 710)

Data type : string

Overrides: Array

always 'see'

Class Constants

Summary:

Method Detail

Summary:
parserSeeTag parserSeeTag (string $name)
string Convert (Converter &$converter)

Constructor parserSeeTag (line 717)

parserSeeTag parserSeeTag( string $name)

sets up the see tag

Parameters

  • string $name: element to link to

Info

Method Convert (line 731)

string Convert( Converter &$converter)

Overridden in child classes 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

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

process this tag through the given output converter

Parameters

  • Converter &$converter: the output converter

Info

Inherited Variables

Inherited Class Variable Summary

Inherited From Class parserTag

parserTag::$type - Type is used by many functions to skip the hassle of

Inherited From Class parserStringWithInlineTags

parserStringWithInlineTags::$value - array of strings and parserInlineTags

Inherited Methods

Inherited Method Summary

Inherited From Class parserLinkTag

parserLinkTag::parserLinkTag() - sets up the link tag


Inherited From Class parserTag

parserTag::parserTag() - Set up the tag

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

parserTag::getString() - Returns the text minus any inline tags

parserTag::HandleEvent() - Called by the parserDescParser when processing a description.


Inherited From Class parserStringWithInlineTags

parserStringWithInlineTags::add() - equivalent to the . operator ($a = $b . $c)

parserStringWithInlineTags::Convert() - Use to convert the string to a real string with all inline tags parsed and linked

parserStringWithInlineTags::getString() - return the string unconverted (all inline tags are taken out - this should only be used in pre-parsing to see if any other text is in the string)

parserStringWithInlineTags::hasInlineTag() - Determine whether the string contains any inline tags

parserStringWithInlineTags::setSource() - Pass source code to any {@source} tags contained within the string for later conversion.

parserStringWithInlineTags::trimmedStrlen() - equivalent to trim(strlen($string))


Inherited From Class parserBase

parserBase::getType() - gets the type

parserBase::getValue() - gets the value

parserBase::setValue() - sets the given value



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