|
|
|
File: c:/www/apache/doc2//parser/PhpdocModuleParser.php
PHPDOC 2000/12/03 - PHPDoc
PhpdocModuleParser
PhpdocObject
|
+-- PhpdocParserRegExp
|
+-- PhpdocParserTags
|
+-- PhpdocParserCore
|
+-- PhpdocUseParser
|
+-- PhpdocConstantParser
|
+-- PhpdocModuleParser
Extracts modules and their documentation from php code.
|
private class PhpdocModuleParser extends PhpdocConstantParser
Extracts modules and their documentation from php code.
|
| |
|
Direct known subclasses: PhpdocVariableParser
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Private Field Summary |
| array |
$emptyModuleEmpty hash that shows the structure of a module. |
| array |
$moduleTagsList of tags allowed within a module doc comment. |
| array |
$moduleGroupsHash of all module groups |
|
Private Method Details |
analyseModule |
|
private array analyseModule( array $para )
|
| |
Central module parsing function.
|
| Parameter |
|
| array |
$para |
|
|
of parsing data |
|
| Returns |
array |
| See Also |
analyseModuleDoc() |
|
analyseModuleDoc |
|
private array analyseModuleDoc( array $para )
|
| |
Extracts the allowed documentation tags out of a module doc comment.
|
| Parameter |
|
|
| Returns |
array |
|
|
Private Field Details |
$emptyModule |
|
private array $emptyModule
>>array(
"name" => "",
"group" => "",
"undoc" => true,
"functions" => array(),
"consts" => array(),
"uses" => array()
)<<
Empty hash that shows the structure of a module.
|
|
$moduleTags |
|
private array $moduleTags
>>array(
"module" => true,
"modulegroup" => true,
"access" => true,
"see" => true,
"link" => true,
"author" => true,
"copyright" => true,
"version" => true,
"since" => true,
"deprecated" => true,
"deprec" => true,
"brother" => true,
"sister" => true,
"exclude" => true,
"package" => true,
"magic" => true,
"todo" => true
)<<
List of tags allowed within a module doc comment.
|
|
$moduleGroups |
|
private array $moduleGroups
>>array()<<
Hash of all module groups
|
|
|
|
|
|
| PHPDoc 1.0beta |