Description
parserBase | --parserStringWithInlineTags | --parserDesc
Located in File: /phpDocumentor/ParserDocBlock.inc
represents a short or long description in a DocBlock (parserDocBlock)
- author: - Greg Beaver <[email protected]>
- version: - $Id: ParserDocBlock.inc 287886 2009-08-30 05:31:05Z ashnazg $
- copyright: - 2002-2008 Gregory Beaver
- since: - 1.0rc1
Class Variables
Summary:
string
$type
$type = '_desc' (line 54)
Data type : string
Overrides: Array
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
always '_desc'
Class Constants
Summary:Method Detail
Summary:
boolean
hasInheritDoc
()
boolean
hasSource
()
Method add (line 60)
void add( mixed $stringOrClass)
Overrides : parserStringWithInlineTags::add() equivalent to the . operator ($a = $b . $c)
Parameters
- mixed $stringOrClass: like parserStringWithInlineTags::add(), this can be a string or parserInlineTag, but it can also be a parserStringWithInlineTags, and the contents will be merged
Info
Method hasInheritDoc (line 81)
boolean hasInheritDoc( )
Info
- return - whether this desc has an {@inheritdoc} inline tag
Method hasSource (line 92)
boolean hasSource( )
Info
- return - whether this desc has an {@source} inline tag
Method replaceInheritDoc (line 104)
void replaceInheritDoc( parserDesc $desc)
replaces {@inheritdoc} with the contents of the parent DocBlock
Parameters
- parserDesc $desc: parent parserDesc, used to retrieve the description