Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/cch/www/pear/PHPDoc/parser/PhpdocUseParser.php
PEAR Repository - PHPDoc

PhpdocUseParser

PhpdocObject
   |
  +-- PhpdocParserRegExp
     |
    +-- PhpdocParserTags
       |
      +-- PhpdocParserCore
         |
        +-- PhpdocUseParser

Extracts use statements (include and friends) an thheir documentation from php code.

 

private class PhpdocUseParser extends PhpdocParserCore

Extracts use statements (include and friends) an thheir documentation from php code.

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

 
Direct known subclasses: PhpdocConstantParser

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

analyseUse( $para)

Takes the result from getPhpdocParagraphs() and interprets it.

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

$emptyUse

Structure of an empty use entry.
array

$useTags

List of allowed tags in use doc comments.

Private Method Details

analyseUse

private void analyseUse( $para )

  Takes the result from getPhpdocParagraphs() and interprets it.

Parameter
$para
Returns void


Private Field Details

$emptyUse

private array $emptyUse

>>array( "type" => "", "file" => "", "undoc" => true )<<


$useTags

private array $useTags

>>array( "return" => true, "see" => true, "link" => true, "authhor" => true, "copyright" => true, "version" => true, "since" => true, "deprecated" => true, "deprec" => true, "include" => true, "exclude" => true, "magic" => true, "todo" => true )<<



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta