Description
parserBase | --parserStringWithInlineTags | --parserTag | --parserReturnTag
Located in File: /phpDocumentor/DocBlockTags.inc
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
Classes extended from parserReturnTag:
- parserPropertyTag
- represents the "@property" tag
- parserVarTag
- represents the "@var" tag
Class Variables
Summary:
mixed
$converted_returnType
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
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
Class Constants
Summary:Method Detail
Summary:
Constructor parserReturnTag (line 382)
parserReturnTag parserReturnTag( string $returnType, parserStringWithInlineTags $value)
set up the tag
Parameters
- string $returnType: returned datatype
- parserStringWithInlineTags $value: tag value
Info
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)
Parameters
- Converter &$converter: the output converter
Info
- return - converted value of the tag
- see - parserStringWithInlineTags::Convert(), parserReturnTag::$converted_returnType
- todo - CS cleanup - rename to convert for camelCase rule