Located in /phpDocumentor/ParserElements.inc [line 321]
parserBase | --parserElement | --parserFunctionAuthor(s):
| Inherited Properties | Inherited Methods | Inherited Constants |
|---|---|---|
|
Inherited From parserElement Inherited From parserBase |
Inherited From parserElement
Inherited From parserBase
|
parameters parsed from function definition.
param name may be null, in which case, updateParams() must be called from the Converter
API Tags:Function returns a reference to an element, instead of a value
set to true if function is declared as:
static variable declarations parsed from function definition
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
void addGlobals(
array
$globals
)
Add all "global $var, $var2" declarations to this function
Parameters:void addParam(
string
$name, string
$value, [boolean
$has_default = true], [null|string
$typehint = null]
)
void addSource(
string|array
$source
)
Set the source code. Always array in PHP 4.3.0+
Parameters:void addStatics(
array
$static, array
$vals
)
Add all "static $var, $var2 = 6" declarations to this function
Parameters:mixed getConflicts(
Converter
&$c
)
Returns all functions in other packages that have the same name as this function
Parameters:string getFunctionCall(
)
Get a human-friendly description of the function call
takes declaration like:
array getIntricateFunctionCall(
$converter,
$paramtags
)
Like getFunctionCall(), but has no English or pre-determined formatting.
Much more flexible.
Parameters:mixed getLink(
Converter
$c, [string
$text = false], [
$returnobj = false]
)
quick way to link to this element
Parameters:string getParam(
string
$name
)
array listStatics(
)