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

Class: parserReturnTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class parserReturnTag

Class Overview

represents the "@return" tag

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

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserReturnTag
Author(s): Information Tags:
Tutorial:  @return
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

Properties

Methods

[ Top ]
Descendants
Child Class Description
parserPropertyTag represents the "@property" tag
parserVarTag represents the "@var" tag

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

parserBase::getType()
gets the type
parserBase::getValue()
gets the value
parserBase::setValue()
sets the given value

[ 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()   set up the tag
string   Convert()   process this tag through the given output converter (sets up the $converted_returnType)

[ Top ]
Properties
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'

API Tags:
See:  parserReturnTag::$returnType


[ Top ]
string   $keyword = 'return' [line 347]

always 'return'


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

Redefined in descendants as:

[ Top ]
mixed   $returnType = 'void' [line 351]

the type a function returns


Redefined in descendants as:

[ Top ]
Methods
Constructor parserReturnTag  [line 382]

  parserReturnTag parserReturnTag( string $returnType, parserStringWithInlineTags $value  )

set up the tag

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


[ Top ]
Convert  [line 398]

  string Convert( Converter &$converter  )

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

Parameters:
Converter   &$converter:  the output converter

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

Information Tags:
Todo:  CS cleanup - rename to convert for camelCase rule

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

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:18:13 -0600 by phpDocumentor 1.4.4