Class: parserSeeTag

Source Location: /PhpDocumentor-1.4.0RC1/phpDocumentor/DocBlockTags.inc

Class Overview

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

represents "@see"

Author(s):

Greg Beaver <cellog at php.net>

Version:

$Id: DocBlockTags.inc,v 1.10 2007/04/19 20:20:57 ashnazg Exp $

Variables

$keyword

Methods

Child classes:

parserUsesTag: represents "@uses"

parserTutorialTag: represents "@tutorial"

Inherited Variables

Class: parserTag

parserTag::$type

Class: parserStringWithInlineTags

parserStringWithInlineTags::$value

Inherited Methods

Class: parserLinkTag

parserLinkTag::parserLinkTag(): URL to link to

Class: parserTag

parserTag::parserTag(): Set up the tag
parserTag::Convert()
parserTag::getString()
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
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()
parserBase::getValue()
parserBase::setValue()

Class Details

[line 535]
represents "@see"

Tutorial: @see
Author: Greg Beaver <cellog@php.net>
Version: $Id: DocBlockTags.inc,v 1.10 2007/04/19 20:20:57 ashnazg Exp $
Since: 1.0rc1

[ Top ]

Class Variables

$keyword = 'see'

[line 541]

always 'see'

Type:	string
Overrides:	Array

[ Top ]

Method Detail

parserSeeTag (Constructor) [line 546]

parserSeeTag parserSeeTag(
string
$name)

Parameters:

string $name — element to link to

[ Top ]

Convert [line 555]

void Convert(
Converter
&$converter)

See: parserStringWithInlineTags::Convert()

Overridden in child classes as:

parserUsesTag::Convert(): Return a link to documentation for other element, and description of how it is used

parserUsedByTag::Convert()

parserTutorialTag::Convert()

Overrides parserTag::Convert() (parent method not documented)

Parameters:

Converter &$converter —

[ Top ]