|
|
|
File: c:/www/apache/doc2//parser/PhpdocFunctionParser.php
PHPDOC 2000/12/03 - PHPDoc
PhpdocFunctionParser
PhpdocObject
|
+-- PhpdocParserRegExp
|
+-- PhpdocParserTags
|
+-- PhpdocParserCore
|
+-- PhpdocUseParser
|
+-- PhpdocConstantParser
|
+-- PhpdocModuleParser
|
+-- PhpdocVariableParser
|
+-- PhpdocFunctionParser
Looks for documented and undocumented functions within a block of php code.
|
private class PhpdocFunctionParser extends PhpdocVariableParser
Looks for documented and undocumented functions within a block of php code.
|
| |
|
Direct known subclasses: PhpdocClassParser
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Private Field Summary |
| array |
$emptyFunctionInternal structur of a function. |
| array |
$functionTagsArray of tags that are allowed in front of the function keyword |
|
Private Method Details |
analyseFunction |
|
private array analyseFunction( array $para )
|
| |
Analyses a function doc comment.
|
| Parameter |
|
|
| Returns |
array |
|
getFunctionArgs |
|
private array getFunctionArgs( string $code )
|
| |
Analyses a function head and returns an array of arguments.
|
| Parameter |
|
| string |
$code |
|
|
code to examine. |
|
| Returns |
array Array of arguments: $args[] = array( optional, default, type, name ). |
|
|
Private Field Details |
$emptyFunction |
|
private array $emptyFunction
>>array(
"name" => "",
"undoc" => true,
"args" => array()
)<<
Internal structur of a function.
|
|
$functionTags |
|
private array $functionTags
>>array(
"parameter" => true,
"param" => true,
"return" => true,
"access" => true,
"abstract" => true,
"static" => true,
"throws" => true,
"see" => true,
"link" => true,
"global" => true,
"version" => true,
"since" => true,
"deprecated" => true,
"deprec" => true,
"brother" => true,
"sister" => true,
"exclude" => true,
"magic" => true,
"author" => true,
"copyright" => true,
"todo" => true
)<<
Array of tags that are allowed in front of the function keyword
|
|
|
|
|
|
| PHPDoc 1.0beta |