Class: parserSeeTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class parserSeeTag

Class Overview

represents the "@see" tag

Located in /phpDocumentor/DocBlockTags.inc [line 704]

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

Author(s):

Greg Beaver <[email protected]>

Information Tags:

Tutorial:	@see
Version:	Release: @[email protected]
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

Properties

$keyword

Methods

[ Top ]

Descendants

Child Class	Description
parserUsesTag	represents the "@uses" tag
parserTutorialTag	represents "@tutorial"

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From parserTag

parserTag::$type

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::$value

Inherited From parserLinkTag

parserLinkTag::parserLinkTag()

sets up the link tag

Inherited From 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 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 parserBase

parserBase::getType()

gets the type

parserBase::getValue()

gets the value

parserBase::setValue()

sets the given value

[ Top ]

Property Summary

string

$keyword

always 'see'

[ Top ]

Method Summary

parserSeeTag	parserSeeTag()	sets up the see tag
string	Convert()	process this tag through the given output converter

[ Top ]

Properties

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"

[ Top ]

Methods

Constructor parserSeeTag [line 717]

parserSeeTag parserSeeTag(
string
$name 
)

sets up the see tag

Parameters:

string

$name:

element to link to

[ Top ]

Convert [line 731]

string Convert(
Converter
&$converter 
)

process this tag through the given output converter

Parameters:

Converter

&$converter:

the output converter

API Tags:

Return:	converted value of the tag
See:	parserStringWithInlineTags::Convert()

Information Tags:

Todo:

CS cleanup - rename to convert for camelCase rule

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

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:18:14 -0600 by phpDocumentor 1.4.4

	phpDocumentor DocBlockTags

[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]