Class parserReturnTag

Description
Direct descendents
Class Description
parserPropertyTag represents the "@property" tag
parserVarTag represents the "@var" tag
Variable Summary
Method Summary
parserReturnTag parserReturnTag (string $returnType, parserStringWithInlineTags $value)
string Convert (Converter &$converter)
Variables
mixed $converted_returnType = false (line 374)

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.  /** @return myclass blahblahblah
  6.  ...

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

string $keyword = 'return' (line 347)

always 'return'


Redefinition of:
parserTag::$keyword
tag name (see, access, etc.)

Redefined in descendants as:
mixed $returnType = 'void' (line 351)

the type a function returns


Redefined in descendants as:

Inherited Variables

Inherited from parserTag

parserTag::$type

Inherited from parserStringWithInlineTags

parserStringWithInlineTags::$value
Methods
Constructor parserReturnTag (line 382)

set up the tag

parserReturnTag parserReturnTag (string $returnType, parserStringWithInlineTags $value)
Convert (line 398)

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

string Convert (Converter &$converter)
  • Converter &$converter: the output converter

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

Inherited Methods

Inherited From parserTag

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

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::add()
parserStringWithInlineTags::Convert()
parserStringWithInlineTags::getString()
parserStringWithInlineTags::hasInlineTag()
parserStringWithInlineTags::setSource()
parserStringWithInlineTags::trimmedStrlen()

Inherited From parserBase

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

Documentation generated on Mon, 05 Dec 2011 20:58:10 -0600 by phpDocumentor 1.4.4