Class: parserDocBlock
Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/ParserDocBlock.inc
Represents a docblock and its components, $desc, $sdesc, $tags, and also $params for functions
Author(s):
Version:
|
|
|
Inherited Variables
|
Inherited Methods
|
Class Details
Class Variables
Method Detail
parserDocBlock (Constructor) [line 256]
parserDocBlock parserDocBlock(
)
|
|
sets package to default
addAccess [line 916]
void addAccess(
string
$value)
|
|
add an @access tag to the tags array
Parameters:
addExample [line 641]
void addExample(
string
$value, string
$path)
|
|
adds an @example tag
Parameters:
addFileSource [line 943]
void addFileSource(
string
$path, array
$source)
|
|
Adds a new @filesource tag to the DocBlock
Parameters:
addFuncGlobal [line 857]
void addFuncGlobal(
string
$type, string
$value)
|
|
adds a function declaration of @global to the $funcglobals array
Parameters:
addKeyword [line 609]
addLink [line 953]
void addLink(
string
$link)
|
|
creates a parserLinkTag and adds it to the $tags array
Parameters:
addName [line 825]
void addName(
string
$value)
|
|
Adds a @name tag to the tag list
Parameters:
addPackage [line 728]
void addPackage(
string
$keyword, mixed
$value)
|
|
Parameters:
addParam [line 520]
addProperty [line 1033]
void addProperty(
$tagName,
$propertyName,
$propertyType,
$value)
|
|
Adds a @property(-read or -write) or @method magic tag to the DocBlock
Parameters:
addReturn [line 976]
addSee [line 964]
void addSee(
string
$keyword, string
$value)
|
|
creates a parserLinkTag and adds it to the $tags array
Parameters:
addStaticVar [line 844]
addTag [line 587]
Used to insert DocBlock Template tags into a docblock
Parameters:
addUnknownTag [line 651]
void addUnknownTag(
string
$keyword, string
$value)
|
|
adds an unknown tag to the $unknown_tags array for use by custom converters
Parameters:
addUses [line 1024]
Add a @uses tag to the DocBlock
Parameters:
addVar [line 993]
creates a parserVarTag and adds it to the $tags array
Parameters:
canSource [line 320]
Tells the DocBlock it can have a @filesource tag Only page-level DocBlocks may have a @filesource tag
cantSource [line 330]
Tells the DocBlock it can't have a @filesource tag Only page-level DocBlocks may have a @filesource tag
changeGlobal [line 866]
void changeGlobal(
integer
$index, string
$name)
|
|
Parameters:
changeParam [line 537]
void changeParam(
integer
$index, string
$name, string|null
$type)
|
|
Parameters:
changeStatic [line 876]
void changeStatic(
integer
$index, string
$name)
|
|
Parameters:
getDesc [line 498]
getEndLineNumber [line 294]
integer getEndLineNumber(
)
|
|
Retrieve ending line number
getExplicitCategory [line 719]
boolean getExplicitCategory(
)
|
|
If the DocBlock has a @category tag, then this returns true
getExplicitPackage [line 698]
boolean getExplicitPackage(
)
|
|
If the DocBlock has a @package tag, then this returns true
getKeyword [line 1076]
mixed getKeyword(
string
$keyword)
|
|
Parameters:
getLineNumber [line 276]
Retrieve starting line number
getSDesc [line 476]
getType [line 1141]
hasInheritDoc [line 453]
listParams [line 1091]
listProperties [line 1109]
listTags [line 1125]
overridePackage [line 666]
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:
postProcess [line 304]
Parse out any html tags from doc comments, and make them into abstract structures
replaceInheritDoc [line 465]
resetParams [line 528]
setDesc [line 438]
setEndLineNumber [line 285]
void setEndLineNumber(
integer
$number)
|
|
Sets the ending line number for the DocBlock
Parameters:
setExplicitCategory [line 710]
void setExplicitCategory(
)
|
|
Used if this docblock has a @category tag. phpDocumentor will guess category for DocBlocks that don't have a @category tag
setExplicitPackage [line 689]
void setExplicitPackage(
)
|
|
Used if this docblock has a @package tag. phpDocumentor will guess package for DocBlocks that don't have a @package tag
setLineNumber [line 267]
void setLineNumber(
integer
$number)
|
|
Sets the starting line number for the DocBlock
Parameters:
setShortDesc [line 396]
Set the short description of the DocBlock Setting the short description is possible by passing in one of three possible parameters: - another DocBlock's short description
- another DocBlock, the short description will be extracted
- a Zend Studio-compatible @desc tag
Parameters:
setSource [line 426]
updateGlobals [line 886]
void updateGlobals(
array
$funcs)
|
|
replaces nameless global variables in the $funcglobals array with their names
Parameters:
updateModifiers [line 355]
void updateModifiers(
array
$modifiers)
|
|
Parameters:
updateParams [line 552]
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:
updateStatics [line 901]
void updateStatics(
array
$funcs)
|
|
replaces nameless static variables in the $statics array with their names
Parameters:
Documentation generated on Mon, 11 Mar 2019 15:50:30 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|
|