Docs For Class parserReturnTag

Description

represents the "@return" tag

tutorial: @return
author: Greg Beaver <[email protected]>
version: Release: @VER@
copyright: 2002-2008 Gregory Beaver
link: http://pear.php.net/PhpDocumentor
link: http://www.phpdoc.org
todo: CS cleanup - change package to PhpDocumentor
todo: CS cleanup - change classname to PhpDocumentor_*
since: 1.0rc1
license: LGPL

Located in /phpDocumentor/DocBlockTags.inc (line 341)

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

Direct descendents

Class	Description
parserPropertyTag	represents the "@property" tag
parserVarTag	represents the "@var" tag

Variable Summary

mixed $converted_returnType

string $keyword

mixed $returnType

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:

class myclass
{
...
}
/** @return myclass blahblahblah
...

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

string $keyword = 'return' (line 347)

always 'return'

Redefinition of:

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

Redefined in descendants as:

parserPropertyTag::$keyword : always 'property'
parserPropertyReadTag::$keyword : always 'property-read'
parserPropertyWriteTag::$keyword : always 'property-write'
parserMethodTag::$keyword : always 'method'
parserVarTag::$keyword : always 'var'
parserParamTag::$keyword : always 'param'
parserStaticvarTag::$keyword : always 'staticvar'

mixed $returnType = 'void' (line 351)

the type a function returns

Redefined in descendants as:

parserPropertyTag::$returnType : the type a property has
parserMethodTag::$returnType : the return type a method has
parserVarTag::$returnType : the type a var has

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)

string $returnType: returned datatype
parserStringWithInlineTags $value: tag value

Convert (line 398)

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

return: converted value of the tag
see: parserStringWithInlineTags::Convert(), parserReturnTag::$converted_returnType
todo: CS cleanup - rename to convert for camelCase rule

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()