Represents a docblock and its components, $desc, $sdesc, $tags, and also $params for functions
Located in /phpDocumentor/ParserDocBlock.inc (line 129)
Line number in the source on which this docblock ends
fix for bug 708559
fix for bug 591396
array of global variable data.
Format: array(index of global variable in @global tag list -OR- global variable name => array(datatype,parserStringWithInlineTags),...)
whether this DocBlock has an @access tag
whether this DocBlock has a @name tag
Line number in the source on which this docblock begins
description of package parsed from @package tag
Unused in this version
array of param data.
Format: array(index of param in function parameter list -OR- parameter name => parserStringWithInlineTags,...)
array of parserPropertyTag, parserPropertyReadTag, parserPropertyWriteTag, parserMethodTag magic tags
This is either a parserReturnTag or false if no return tag is present
array of static variable data.
Format: array(index of static variable in @global tag list -OR- static variable name => parserStaticvarTag,...)
description of subpackage parsed from @package tag
Unused in this version
array of parserTags
array of unrecognized parserTags
This is either a parserVarTag or false if no var tag is present
sets package to default
add an @access tag to the tags array
adds an @example tag
Adds a new @filesource tag to the DocBlock
adds a function declaration of @global to the $funcglobals array
creates a parserLinkTag and adds it to the $tags array
Adds a @name tag to the tag list
Adds a @property(-read or -write) or @method magic tag to the DocBlock
creates a parserReturnTag and adds it to the $tags array
creates a parserLinkTag and adds it to the $tags array
adds an unknown tag to the $unknown_tags array for use by custom converters
Add a @uses tag to the DocBlock
creates a parserVarTag and adds it to the $tags array
Tells the DocBlock it can have a @filesource tag
Only page-level DocBlocks may have a @filesource tag
Tells the DocBlock it can't have a @filesource tag
Only page-level DocBlocks may have a @filesource tag
Retrieve ending line number
If the DocBlock has a @category tag, then this returns true
If the DocBlock has a @package tag, then this returns true
Retrieve starting line number
set the element's package to the passed values. Used in phpDocumentor_IntermediateParser to align package of
elements inside a class or procedural page to the package of the class/procedural page
Parse out any html tags from doc comments, and make them into
abstract structures
Wrapper for parserDesc::replaceInheritDoc()
Also replaces {@inheritdoc} in the $processed_desc
Sets the ending line number for the DocBlock
Used if this docblock has a @category tag.
phpDocumentor will guess category for DocBlocks that don't have a @category tag
Used if this docblock has a @package tag.
phpDocumentor will guess package for DocBlocks that don't have a @package tag
Sets the starting line number for the DocBlock
Set the short description of the DocBlock
Setting the short description is possible by passing in one of three possible parameters:
Passes to parserStringWithInlineTags::setSource()
After passing, it calls postProcess() to set up the new source
replaces nameless global variables in the $funcglobals array with their names
replaces nameless parameters in the $params array with their names
add @param tags for params in the function with no entry
replaces nameless static variables in the $statics array with their names
Documentation generated on Mon, 05 Dec 2011 21:45:27 -0600 by phpDocumentor 1.4.4