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

Class: parserSeeTag

Source Location: /PhpDocumentor-1.2.0beta2/phpDocumentor/DocBlockTags.inc

Class Overview

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

represents "@see"


Author(s):

Version:

  • $Id: DocBlockTags.inc,v 1.3 2003/01/18 07:25:19 CelloG Exp $

Variables

Methods


Child classes:

parserUsesTag
represents "@uses"
parserUsedByTag
This is a virtual tag, it is created by @uses to cross-reference the used element
parserTutorialTag
represents "@tutorial"

Inherited Variables

Inherited Methods

Class: parserLinkTag

parserLinkTag::parserLinkTag()
URL to link to

Class: parserTag

parserTag::parserTag()
parserTag::Convert()
parserTag::getString()
parserTag::HandleEvent()

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
parserStringWithInlineTags::setSource()
parserStringWithInlineTags::trimmedStrlen()
equivalent to trim(strlen($string))

Class: parserBase

parserBase::getType()
parserBase::getValue()
parserBase::setLineNum()
parserBase::setValue()

Class Details

[line 327]
represents "@see"


[ Top ]


Class Variables

$keyword =  'see'

[line 333]

always 'see'

Type:   string
Overrides:   Array


[ Top ]



Method Detail

parserSeeTag (Constructor)   [line 335]

parserSeeTag parserSeeTag( mixed $name)


[ Top ]

Convert   [line 344]

void Convert( Converter &$converter)


Overridden in child classes as:

parserUsedByTag::Convert()
parserTutorialTag::Convert()

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

Parameters:

Converter   &$converter     

[ Top ]


Documentation generated on Fri, 30 Apr 2004 22:09:38 +0200 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.