Class parserReturnTag

(line 341)



Located in File: /phpDocumentor/

represents the "@return" tag

Classes extended from parserReturnTag:
represents the "@property" tag
represents the "@var" tag

Class Variables

string $keyword
mixed $returnType

$converted_returnType = false (line 374)

Data type : mixed

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


  1.  class myclass
  2.  {
  3.  ...
  4.  }
  5.  /** @return myclass blahblahblah
  6.  ...

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

$keyword = 'return' (line 347)

Data type : string

Overrides: Array

always 'return'

$returnType = 'void' (line 351)

Data type : mixed

the type a function returns

Class Constants


Method Detail

parserReturnTag parserReturnTag (string $returnType, parserStringWithInlineTags $value)
string Convert (Converter &$converter)

Constructor parserReturnTag (line 382)

parserReturnTag parserReturnTag( string $returnType, parserStringWithInlineTags $value)

set up the tag



Method Convert (line 398)

string Convert( Converter &$converter)

Overrides : parserTag::Convert() Perform the output conversion on this parserTag using the output converter that is passed in

process this tag through the given output converter (sets up the $converted_returnType)


  • Converter &$converter: the output converter


Inherited Variables

Inherited Class Variable Summary

Inherited From Class parserTag

parserTag::$type - Type is used by many functions to skip the hassle of

Inherited From Class parserStringWithInlineTags

parserStringWithInlineTags::$value - array of strings and parserInlineTags

Inherited Methods

Inherited Method Summary

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

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

Inherited From Class parserBase

parserBase::getType() - gets the type

parserBase::getValue() - gets the value

parserBase::setValue() - sets the given value

Documentation generated on Mon, 05 Dec 2011 21:26:20 -0600 by phpDocumentor 1.4.4