Packageindex Classtrees Modulegroups Elementlist Report XML Files

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

AuthorsUlf Wendel <ulf.wendel@redsys.de>
Version0.1alpha

 
Direct known subclasses: PhpdocModuleParser

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

array

checkConstantDoc(array $constant)

Compares the data from the parser with the optional @const[ant] tags
void

analyseConstant( $para)

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

$emptyConstant

array

$constantTags

Private Method Details

checkConstantDoc

private array checkConstantDoc( array $constant )

  Compares the data from the parser with the optional

Parameter
array $constant
Hash with the data of the current constant paragraph
Returns array $constant


analyseConstant

private void analyseConstant( $para )

 

Parameter
$para
Returns void


Private Field Details

$emptyConstant

private array $emptyConstant

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


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



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta