|
|
File: c:/www/apache/doc2//parser/PhpdocConstantParser.php
PHPDOC 2000/12/03 - PHPDoc
PhpdocConstantParser
PhpdocObject | +-- PhpdocParserRegExp | +-- PhpdocParserTags | +-- PhpdocParserCore | +-- PhpdocUseParser | +-- PhpdocConstantParser
Extracts define statements and their documentation from php code.
|
private class PhpdocConstantParser extends PhpdocUseParser
Extracts define statements and their documentation from php code.
|
|
Direct known subclasses: PhpdocModuleParser
|
|
|
|
|
|
|
|
|
|
|
Private Field Summary |
array |
$emptyConstantInternal structure use to save a constant. |
array |
$constantTagsDoc Tags allowed with const[ant]. |
|
Private Method Details |
analyseConstant |
private void analyseConstant( array $para )
|
|
Scans the given constant doc comment.
|
Parameter |
|
|
Returns |
void |
|
checkConstantDoc |
private array checkConstantDoc( array $constant )
|
|
Compares the data from the parser with the optional const[ant] tags
|
Parameter |
|
array |
$constant |
|
|
with the data of the current constant paragraph |
|
Returns |
array $constant |
|
|
Private Field Details |
$emptyConstant |
private array $emptyConstant
>>array(
"name" => "",
"value" => "",
"undoc" => true
) <<
Internal structure use to save a constant.
|
|
$constantTags |
private array $constantTags
>>array(
"access" => true,
"see" => true,
"link" => true,
"constant" => true,
"const" => true,
"author" => true,
"copyright" => true,
"exclude" => true,
"magic" => true,
"todo" => true
) <<
Doc Tags allowed with const[ant].
|
|
|
|
|
PHPDoc 1.0beta |