Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: c:/www/apache/doc2//parser/PhpdocConstantParser.php
PHPDOC 2000/12/03 - 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>
Version$Id: $

 
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

void

analyseConstant(array $para)

Scans the given constant doc comment.
array

checkConstantDoc(array $constant)

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

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, $application, $warn, $flag_output

Private Field Summary

array

$emptyConstant

Internal structure use to save a constant.
array

$constantTags

Doc Tags allowed with const[ant].

Private Method Details

analyseConstant

private void analyseConstant( array $para )

  Scans the given constant doc comment.

Parameter
array $para
Returns void


checkConstantDoc

private array checkConstantDoc( array $constant )

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

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


Private Field Details

$emptyConstant

private array $emptyConstant

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

Internal structure use to save a constant.


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

Doc Tags allowed with const[ant].



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta