|
|
|
File: c:/www/apache/doc2//parser/PhpdocVariableParser.php
PHPDOC 2000/12/03 - PHPDoc
PhpdocVariableParser
PhpdocObject | +-- PhpdocParserRegExp | +-- PhpdocParserTags | +-- PhpdocParserCore | +-- PhpdocUseParser | +-- PhpdocConstantParser | +-- PhpdocModuleParser | +-- PhpdocVariableParser
Extract class variables and their documentation from phpcode
|
private class PhpdocVariableParser extends PhpdocModuleParser
Extract class variables and their documentation from phpcode
|
| |
|
Direct known subclasses: PhpdocFunctionParser
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Private Field Summary |
| array |
$emptyVariableArray with default values of a variable |
| array |
$variableTagsArray of tags that are allowed in front of the var keyword |
|
Private Method Details |
analyseVariable |
|
private array analyseVariable( array $para )
|
| |
Analyses a variable doc comment
|
| Parameter |
|
| array |
$para |
|
|
returned by getPhpdocParagraph() |
|
| Returns |
array |
|
checkVarDocs |
|
private array checkVarDocs( array $variable )
|
| |
Compares the var tag informations with the analyse of the source code.
|
| Parameter |
|
|
| Returns |
array $variable |
|
|
Private Field Details |
$emptyVariable |
|
private array $emptyVariable
>>array(
"name" => "",
"undoc" => true
)<<
Array with default values of a variable
|
|
$variableTags |
|
private array $variableTags
>>array(
"access" => true,
"abstract" => true,
"static" => true,
"final" => true,
"see" => true,
"link" => true,
"var" => true,
"version" => true,
"since" => true,
"deprecated" => true,
"deprec" => true,
"brother" => true,
"sister" => true,
"exclude" => true,
"magic" => true,
"todo" => true
)<<
Array of tags that are allowed in front of the var keyword
|
|
|
|
|
|
| PHPDoc 1.0beta |