Represents a docblock and its components, $desc, $sdesc, $tags, and also $params for functions
Located in /phpDocumentor/ParserDocBlock.inc [line 129]
Author(s):Line number in the source on which this docblock ends
Information Tags:array of global variable data.
Format: array(index of global variable in @global tag list -OR- global variable name => array(datatype,parserStringWithInlineTags),...)
Line number in the source on which this docblock begins
Information Tags: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
This is either a parserVarTag or false if no var tag is present
parserDocBlock parserDocBlock(
)
sets package to default
void addAccess(
string
$value
)
add an @access tag to the tags array
Parameters:void addExample(
string
$value, string
$path
)
adds an @example tag
Parameters:void addFileSource(
string
$path, array
$source
)
Adds a new @filesource tag to the DocBlock
Parameters:void addFuncGlobal(
string
$type, string
$value
)
adds a function declaration of @global to the $funcglobals array
Parameters:void addKeyword(
string
$keyword, parserStringWithInlineTags
$value
)
void addLink(
string
$link
)
creates a parserLinkTag and adds it to the $tags array
Parameters:void addName(
string
$value
)
Adds a @name tag to the tag list
Parameters:void addPackage(
string
$keyword, mixed
$value
)
void addParam(
string
$paramVar,
$paramType, parserStringWithInlineTags
$value
)
void addProperty(
$tagName,
$propertyName,
$propertyType,
$value
)
Adds a @property(-read or -write) or @method magic tag to the DocBlock
Parameters:void addReturn(
string
$returnType, parserStringWithInlineTags
$value
)
creates a parserReturnTag and adds it to the $tags array
Parameters:void addSee(
string
$keyword, string
$value
)
creates a parserLinkTag and adds it to the $tags array
Parameters:void addStaticVar(
string
$staticvar, string
$type, parserStringWithInlineTags
$descrip
)
void addTag(
parserTag
$tag
)
Used to insert DocBlock Template tags into a docblock
Parameters:void addUnknownTag(
string
$keyword, string
$value
)
adds an unknown tag to the $unknown_tags array for use by custom converters
Parameters:void addUses(
string
$seeel, parserStringWithInlineTags
$description
)
Add a @uses tag to the DocBlock
Parameters:void addVar(
string
$varType, parserStringWithInlineTags
$value
)
creates a parserVarTag and adds it to the $tags array
Parameters:void canSource(
)
Tells the DocBlock it can have a @filesource tag
Only page-level DocBlocks may have a @filesource tag
void cantSource(
)
Tells the DocBlock it can't have a @filesource tag
Only page-level DocBlocks may have a @filesource tag
void changeGlobal(
integer
$index, string
$name
)
void changeParam(
integer
$index, string
$name, string|null
$type
)
void changeStatic(
integer
$index, string
$name
)
string getDesc(
Converter
&$converter
)
boolean getExplicitCategory(
)
If the DocBlock has a @category tag, then this returns true
boolean getExplicitPackage(
)
If the DocBlock has a @package tag, then this returns true
mixed getKeyword(
string
$keyword
)
string getSDesc(
Converter
&$converter
)
array listParams(
)
array listProperties(
)
void overridePackage(
string
$category, string
$package, string
$subpackage, string
$elname, string
$type
)
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
Parameters:void postProcess(
)
Parse out any html tags from doc comments, and make them into
abstract structures
void replaceInheritDoc(
parserDesc
$desc
)
Wrapper for parserDesc::replaceInheritDoc()
Also replaces {@inheritdoc} in the $processed_desc
Parameters:void setEndLineNumber(
integer
$number
)
Sets the ending line number for the DocBlock
Parameters:void setExplicitCategory(
)
Used if this docblock has a @category tag.
phpDocumentor will guess category for DocBlocks that don't have a @category tag
void setExplicitPackage(
)
Used if this docblock has a @package tag.
phpDocumentor will guess package for DocBlocks that don't have a @package tag
void setLineNumber(
integer
$number
)
Sets the starting line number for the DocBlock
Parameters:void setShortDesc(
parserDesc|parserDocBlock|parserTag
$desc
)
Set the short description of the DocBlock
Setting the short description is possible by passing in one of three possible parameters:
void setSource(
string|array
$source, [false|string
$class = false]
)
Passes to parserStringWithInlineTags::setSource()
After passing, it calls postProcess() to set up the new source
Parameters:void updateGlobals(
array
$funcs
)
replaces nameless global variables in the $funcglobals array with their names
Parameters:void updateModifiers(
array
$modifiers
)
void updateParams(
array
$params
)
replaces nameless parameters in the $params array with their names
add @param tags for params in the function with no entry
Parameters:void updateStatics(
array
$funcs
)
replaces nameless static variables in the $statics array with their names
Parameters: