Child classes:
- parserPropertyTag
- represents the "@property" tag
- parserVarTag
- represents the "@var" tag
Inherited Methods
Class: 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.
Class: 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))
Class: parserBase
- parserBase::getType()
- gets the type
- parserBase::getValue()
- gets the value
- parserBase::setValue()
- sets the given value
Class Details
represents the "@return" tag
Tags:
- 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
[ Top ]
Class Variables
$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'
Tags:
- var - either the same as $returnType or a link to the docs for a class
- see - parserReturnTag::$returnType
Type: mixed
Overrides:
[ Top ]
$keyword = 'return'
[ Top ]
$returnType = 'void'
[ Top ]
Class Methods
parserReturnTag
parserReturnTag parserReturnTag(
string
$returnType, parserStringWithInlineTags
$value)
[line 382]
set up the tag
Parameters:
- string $returnType - returned datatype
- parserStringWithInlineTags $value - tag value
[ Top ]
Convert
string Convert(
Converter
&$converter)
[line 398]
process this tag through the given output converter (sets up the $converted_returnType)
Tags:
- return - converted value of the tag
- see - parserStringWithInlineTags::Convert(), parserReturnTag::$converted_returnType
- todo - CS cleanup - rename to convert for camelCase rule
Overrides parserTag::Convert() (Perform the output conversion on this parserTag using the output converter that is passed in)
Parameters:
- Converter &$converter - the output converter
[ Top ]