false|integer $endlinenumber = false (line 158)

Line number in the source on which this docblock ends

• since: 1.2

boolean $explicitpackage = false (line 212)

fix for bug 591396

• usedby: parserDocBlock::setExplicitPackage()

boolean $hasaccess = false (line 227)

whether this DocBlock has an @access tag

false|integer $linenumber = false (line 152)

Line number in the source on which this docblock begins

• since: 1.2

string $packagedescrip = '' (line 237)

description of package parsed from @package tag

Unused in this version

array $processed_desc = false (line 138)

• var: array of parserDescs

mixed $properties = array() (line 197)

array of parserPropertyTag, parserPropertyReadTag, parserPropertyWriteTag, parserMethodTag magic tags

array $tags = array() (line 163)

array of parserTags

mixed $var = false (line 207)

This is either a parserVarTag or false if no var tag is present

addAccess (line 916)

add an @access tag to the tags array

• string $value: should be either public or private

addFileSource (line 943)

Adds a new @filesource tag to the DocBlock

• tutorial: @filesource

• string $path: full path to the file
• array $source: tokenized source code, ordered by line number

addKeyword (line 609)

• global: array $_phpDocumentor_setting: used to determine whether to add the @internal tag or not

• string $keyword: tag name
• parserStringWithInlineTags $value: the contents of the tag

addName (line 825)

Adds a @name tag to the tag list

• string $value: new name of element

addParam (line 520)

• string $paramVar: if empty, param is indexed in the order received and set using changeParam()
• parserStringWithInlineTags $value
• $paramType

addReturn (line 976)

creates a parserReturnTag and adds it to the $tags array

• string $returnType: the one-word name of the return type (mixed should be used if more than one type)
• parserStringWithInlineTags $value

addStaticVar (line 844)

• string $staticvar: if empty, staticvar is indexed in the order received and set using changeStatic()
• string $type: data type
• parserStringWithInlineTags $descrip

addUnknownTag (line 651)

adds an unknown tag to the $unknown_tags array for use by custom converters

• string $keyword: tag name
• string $value: tag value

addVar (line 993)

creates a parserVarTag and adds it to the $tags array

• string $varType: the one-word name of the variable type (mixed should be used if more than one type)
• parserStringWithInlineTags $value

cantSource (line 330)

Tells the DocBlock it can't have a @filesource tag

Only page-level DocBlocks may have a @filesource tag

changeParam (line 537)

• integer $index: index of parameter in the $params array
• string $name: name of the parameter to set in the $params array
• string|null $type: type of the parameter

getDesc (line 498)

• Converter &$converter: takes $desc and converts it to a string and returns it if present, otherwise returns ''

getExplicitCategory (line 719)

If the DocBlock has a @category tag, then this returns true

getKeyword (line 1076)

• return: false if no keyword, unconverted value if one keyword, array of unconverted values if more than one keyword

• string $keyword

getSDesc (line 476)

• Converter &$converter: takes $sdesc and converts it to a string and returns it if present, otherwise returns ''

hasInheritDoc (line 453)

Wrapper for parserDesc::hasInheritDoc()

listProperties (line 1109)

• return: Format: array('var' => tag name, 'data' => unconverted tag value)

overridePackage (line 666)

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

• string $category
• string $package
• string $subpackage
• string $elname: element name
• string $type: element type (include, define, var, method, global, function, const)

replaceInheritDoc (line 465)

Wrapper for parserDesc::replaceInheritDoc()

Also replaces {@inheritdoc} in the $processed_desc

• parserDesc $desc

setDesc (line 438)

• parserDesc|parserDocBlock $desc: sets $desc

setExplicitCategory (line 710)

Used if this docblock has a @category tag.

phpDocumentor will guess category for DocBlocks that don't have a @category tag

• uses: parserDocBlock::$explicitcategory

setLineNumber (line 267)

Sets the starting line number for the DocBlock

• integer $number

setSource (line 426)

Passes to parserStringWithInlineTags::setSource()

After passing, it calls postProcess() to set up the new source

• string|array $source: tokenized highlight-ready source code
• false|string $class: name of class if this is a method source

updateModifiers (line 355)

• array $modifiers

updateStatics (line 901)

replaces nameless static variables in the $statics array with their names

• array $funcs