Class: parserSeeTag

Source Location: /PEAR/PhpDocumentor/phpDocumentor/DocBlockTags.inc

Class Overview

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

represents the "@see" tag

Author(s):

Greg Beaver <cellog@php.net>

Version:

Release: 1.4.2

Copyright:

2002-2008 Gregory Beaver

Variables

$keyword

Methods

Child classes:

parserUsesTag: represents the "@uses" tag

parserTutorialTag: represents "@tutorial"

Inherited Variables

Class: parserTag

parserTag::$type

Class: parserStringWithInlineTags

parserStringWithInlineTags::$value

Inherited Methods

Class: parserLinkTag

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

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.

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

Class: parserBase

parserBase::getType(): gets the type
parserBase::getValue(): gets the value
parserBase::setValue(): sets the given value

Class Details

[line 702]
represents the "@see" tag

Tags:

tutorial:	@see
author:	Greg Beaver <cellog@php.net>
version:	Release: 1.4.2
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

[ Top ]

Class Variables

$keyword = 'see'

[line 708]

always 'see'

Type:	string
Overrides:	Array

[ Top ]

Class Methods

constructor parserSeeTag [line 715]

parserSeeTag parserSeeTag(
string
$name)

sets up the see tag

Parameters:

string

$name

element to link to

[ Top ]

method Convert [line 729]

string Convert(
Converter
&$converter)

process this tag through the given output converter

Tags:

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

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)

Parameters:

Converter

&$converter

the output converter

[ Top ]

Documentation generated on Sun, 30 Mar 2008 23:06:31 -0500 by phpDocumentor 1.4.2