Class: parserDesc

Source Location: /phpDocumentor/ParserDocBlock.inc

Class parserDesc

Class Overview

represents a short or long description in a DocBlock (parserDocBlock)

Located in /phpDocumentor/ParserDocBlock.inc [line 47]

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserDesc

Author(s):

Greg Beaver <[email protected]>

Information Tags:

Version:	$Id: ParserDocBlock.inc 287886 2009-08-30 05:31:05Z ashnazg $
Copyright:	2002-2008 Gregory Beaver
Since:	1.0rc1

Properties

$type

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::$value

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

string

$type

Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'

[ Top ]

Method Summary

void	add()
boolean	hasInheritDoc()
boolean	hasSource()
void	replaceInheritDoc()	replaces {@inheritdoc} with the contents of the parent DocBlock

[ Top ]

Properties

string $type = '_desc' [line 54]

Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'

always '_desc'

Redefinition of:

parserStringWithInlineTags::$type: Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'...

[ Top ]

Methods

add [line 60]

void add(
mixed
$stringOrClass 
)

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

Redefinition of:

parserStringWithInlineTags::add(): equivalent to the . operator ($a = $b . $c)

[ Top ]

hasInheritDoc [line 81]

boolean hasInheritDoc(
)

API Tags:

Return:

whether this desc has an {@inheritdoc} inline tag

[ Top ]

hasSource [line 92]

boolean hasSource(
)

API Tags:

Return:

whether this desc has an {@source} inline tag

[ Top ]

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

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:20:42 -0600 by phpDocumentor 1.4.4

	phpDocumentor ParserDocBlock

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