Class: parserReturnTag

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

Class Overview

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserReturnTag

represents "@return"

Author(s):

Greg Beaver <mailto:cellog at users.sourceforge.net>

Version:

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

Variables

Methods

Child classes:

parserVarTag: represents "@var"

Inherited Variables

Inherited Methods

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 176]
represents "@return"

Version: $Id: DocBlockTags.inc,v 1.3 2003/01/18 07:25:19 CelloG Exp $
Since: 1.0rc1
Author: Greg Beaver <mailto:cellog@users.sourceforge.net>

[ Top ]

Class Variables

$converted_returnType = false

[line 203]

contains a link to the documentation for a class passed as a type in @return, @var or @param

Example:


1     class myclass
2      {
3      ...
4      }
5

In this case, $converted_returnType will contain a link to myclass instead of the string 'myclass'

Var: either the same as $returnType or a link to the docs for a class
See: parserReturnTag::$returnType

Type:

mixed

[ Top ]

$keyword = 'return'

[line 182]

always 'return'

Type:	string
Overrides:	Array

[ Top ]

$returnType = 'void'

[line 186]

the type a function returns

Type:

mixed

[ Top ]

Method Detail

parserReturnTag (Constructor) [line 209]

parserReturnTag parserReturnTag(
string
$returnType, parserStringWithInlineTags
$value)

Parameters:

string	`$returnType`	—
parserStringWithInlineTags	`$value`	—

[ Top ]

Convert [line 221]

string Convert(
Converter
&$converter)

sets up $converted_returnType

Return: converted value of the tag
See: parserStringWithInlineTags::Convert(), parserReturnTag::$converted_returnType

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

Parameters:

Converter &$converter —

[ Top ]