Packageindex Classtrees Modulegroups Elementlist Report XML Files

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

PhpdocModuleParser

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

Extracts modules and their documentation from php code.

 

private class PhpdocModuleParser extends PhpdocConstantParser

Extracts modules and their documentation from php code.

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

 
Direct known subclasses: PhpdocVariableParser

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

analyseModule(array $para)

Central module parsing function.
void

analyseModuleDoc(array $para)

Extracts the allowed documentation tags out of a module doc comment.

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

$emptyModule

Empty hash that shows the structure of a module.
array

$moduleTags

List of tags allowed within a module doc comment.
array

$moduleGroups

Hash of all module groups

Private Method Details

analyseModule

private void analyseModule( array $para )

  Central module parsing function.

Parameter
array $para
Array of parsing data
Returns void

See Also analyseModuleDoc()

analyseModuleDoc

private void analyseModuleDoc( array $para )

  Extracts the allowed documentation tags out of a module doc comment.

Parameter
array $para
Module paragraph
Returns void


Private Field Details

$emptyModule

private array $emptyModule

>>array( "name" => "", "group" => "", "undoc" => true, "functions" => array(), "consts" => array(), "uses" => array() )<<


$moduleTags

private array $moduleTags

>>array( "module" => true, "modulegroup" => true, "access" => true, "see" => true, "link" => true, "author" => true, "copyright" => true, "version" => true, "since" => true, "deprecated" => true, "deprec" => true, "brother" => true, "sister" => true, "exclude" => true, "package" => true, "magic" => true, "todo" => true )<<


$moduleGroups

private array $moduleGroups

>>array()<<



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta