Class: parserReturnTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class parserReturnTag

Class Overview

represents "@return"

Located in /phpDocumentor/DocBlockTags.inc [line 278]

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

Author(s):

Greg Beaver <[email protected]>

Information Tags:

Version:	$Id: DocBlockTags.inc,v 1.8 2006/10/24 04:18:14 cellog Exp $
Since:	1.0rc1
Tutorial:	@return

Properties

Methods

[ Top ]

Direct descendents

Child Class	Description
parserVarTag	represents "@var"

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From parserTag

parserTag::$type

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::$value

Inherited From parserTag

parserTag::parserTag()

Set up the tag

parserTag::Convert()

parserTag::getString()

parserTag::HandleEvent()

Called by the parserDescParser when processing a description.

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

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 parserBase

parserBase::getType()

parserBase::getValue()

parserBase::setValue()

[ Top ]

Property Summary

mixed	$converted_returnType	contains a link to the documentation for a class passed as a type in @return, @var or @param
string	$keyword	always 'return'
mixed	$returnType	the type a function returns

[ Top ]

Method Summary

parserReturnTag	parserReturnTag()
string	Convert()	sets up $converted_returnType

[ Top ]

Properties

mixed $converted_returnType = false [line 308]

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

Example:

class myclass
{
...
}

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

API Tags:

See:

parserReturnTag::$returnType

[ Top ]

string $keyword = 'return' [line 284]

always 'return'

Redefinition of:

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

Redefined in descendants as:

parserVarTag::$keyword : always 'var'
parserParamTag::$keyword : always 'param'
parserStaticvarTag::$keyword : always 'staticvar'

[ Top ]

mixed $returnType = 'void' [line 288]

the type a function returns

Redefined in descendants as:

parserVarTag::$returnType : the type a var has

[ Top ]

Methods

Constructor parserReturnTag [line 314]

parserReturnTag parserReturnTag(
string
$returnType, parserStringWithInlineTags
$value 
)

Parameters:

string	$returnType:
parserStringWithInlineTags	$value:

[ Top ]

Convert [line 326]

string Convert(
Converter
&$converter 
)

sets up $converted_returnType

Parameters:

Converter

&$converter:

API Tags:

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

Redefinition of:

parserTag::Convert()

[ Top ]

Documentation generated on Tue, 24 Oct 2006 09:22:19 -0500 by phpDocumentor 1.3.1

	phpDocumentor DocBlockTags

[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]