Packageindex Classtrees Modulegroups Elementlist Report XML Files

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

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

 
Direct known subclasses: PhpdocFunctionParser

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

analyseVariable(array $para)

Analyses a variable doc comment
array

checkVarDocs(array $variable)

Compares the @var tag informations with the analyse of the source code.

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

$emptyVariable

Array with default values of a variable
array

$variableTags

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

Private Method Details

analyseVariable

private void analyseVariable( array $para )

  Analyses a variable doc comment

Parameter
array $para
Hash returned by getPhpdocParagraph()
Returns void


checkVarDocs

private array checkVarDocs( array $variable )

  Compares the

Parameter
array $variable
Returns array $variable


Private Field Details

$emptyVariable

private array $emptyVariable

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

See Also v::v, analyseVariableParagraph()

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

See Also analyseVariableParagraph()


Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta