Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/cch/www/pear/PHPDoc/parser/PhpdocFunctionParser.php
PEAR Repository - 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

AuthorsUlf Wendel <ulf@redsys.de>
Version0.2

 
Direct known subclasses: PhpdocClassParser

Methods inherited from PhpdocVariableParser

analysevariable, checkvardocs

Methods inherited from PhpdocModuleParser

analysemodule, analysemoduledoc

Methods inherited from PhpdocConstantParser

checkconstantdoc, analyseconstant

Methods inherited from PhpdocUseParser

analyseuse

Methods inherited from PhpdocParserCore

getphpdocparagraphs, getmodulesandclasses, getmoduledoc, getclasses, extractphpdoc, getdescription, getvalue, getvariabletypeandvalue

Methods inherited from PhpdocParserTags

analysetags, analyseseetagregs, gettags, gettagpos, checkparsererrors

Methods inherited from PhpdocParserRegExp

buildcomplexregexps

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

Private Method Summary

void

analyseFunction( $para)

Analyses a function doc comment.
array

getFunctionArgs(string $code)

Analyses a function head and returns an array of arguments.

Fields inherited from PhpdocVariableParser

$emptyvariable, $variabletags

Fields inherited from PhpdocModuleParser

$emptymodule, $moduletags, $modulegroups

Fields inherited from PhpdocConstantParser

$emptyconstant, $constanttags

Fields inherited from PhpdocUseParser

$emptyuse, $usetags

Fields inherited from PhpdocParserRegExp

$phpdoc_tags, $c_base, $c_complex, $php_base, $php_complex, $tags

Fields inherited from PhpdocObject

$err, $flag_output, $application, $warn

Private Field Summary

array

$emptyFunction

Internal structur of a function.
array

$functionTags

Array of tags that are allowed in front of the function keyword

Private Method Details

analyseFunction

private void analyseFunction( $para )

  Analyses a function doc comment.

Parameter
$para
Returns void


getFunctionArgs

private array getFunctionArgs( string $code )

  Analyses a function head and returns an array of arguments.

Parameter
string $code
PHP code to examine.
Returns array

Array of arguments: $args[] = array( optional, default, type, name ).

See Also getVariableTypeAndValue()

Private Field Details

$emptyFunction

private array $emptyFunction

>>array( "name" => "", "undoc" => true, "args" => array() )<<

See Also f::f, analyseFunctionParagraph()

$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 )<<

See Also analyseFunctionParagraph()


Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta