Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/cch/www/pear/PHPDoc/analyser/PhpdocModuleAnalyser.php
PEAR Repository - PHPDoc

PhpdocModuleAnalyser

PhpdocObject
   |
  +-- PhpdocAnalyser
     |
    +-- PhpdocModuleAnalyser

Analyses a modulegroup.

 

private class PhpdocModuleAnalyser extends PhpdocAnalyser

Analyses a modulegroup.

AuthorsUlf Wendel <ulf.wendel@phpdoc.de>
Version1.0beta

 

Methods inherited from PhpdocAnalyser

add_number_suffix, checkargdocs

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

Public Method Summary

void

setModulegroup(array $modulegroup)

Sets the data of the modulegroup to analyse.
mixed

getModule()

Returns a module from the modulegroup or false if there are no more modules.

Private Method Summary

void

buildModulelist()

Builds an internal list of all modules in the modulegroup.
void

analyse()

Starts the analysing of the raw parsing data.
void

findUndocumented()

Looks for undocumented elements and adds a warning if neccessary.
void

checkFunctionArgs()

Compares the @param tags with the function head found.
void

updateBrothersSisters()

Handles @brother and @sister.
void

updateBrotherSisterElements( $group, $modulename, $type)

Updates certain elements that use @brother and @sister.
void

updateAccessReturn()

Updates the @access and @return tag values.
void

updateAccessReturnElements( $group, $modulename, $type)

Updates @access and @return for certain elements.
void

updateAccessElements( $group, $modulename, $type)

Updates @access tags.

Fields inherited from PhpdocAnalyser

$flag_get

Fields inherited from PhpdocObject

$err, $flag_output, $application, $warn

Private Field Summary

array

$modulegroup

Module data
array

$modulelist

List of all modules in the modulegroup
array

$undocumentedFields

Puuuh - findUndocumented() needs this.

Public Method Details

setModulegroup

public void setModulegroup( array $modulegroup )

  Sets the data of the modulegroup to analyse.

Parameter
array $modulegroup
Raw modulegroup data from the parser.
Returns void


getModule

public mixed getModule( )

  Returns a module from the modulegroup or false if there are no more modules.

Returns mixed

False if there no more modules in the modulegroup otherwise
an array with the data of a module.


Private Method Details

buildModulelist

private void buildModulelist( )

  Builds an internal list of all modules in the modulegroup.

Returns void

See Also $modulelist, $modulegroup

analyse

private void analyse( )

  Starts the analysing of the raw parsing data.

Returns void


findUndocumented

private void findUndocumented( )

  Looks for undocumented elements and adds a warning if neccessary.

Returns void


checkFunctionArgs

private void checkFunctionArgs( )

  Compares the

Returns void


updateBrothersSisters

private void updateBrothersSisters( )

  Handles

Returns void

See Also u::u

updateBrotherSisterElements

private void updateBrotherSisterElements( $group, $modulename, $type )

  Updates certain elements that use

Parameter
$group
$modulename
$type
Returns void


updateAccessReturn

private void updateAccessReturn( )

  Updates the

Returns void

See Also updateAccessReturnElements(), updateAccessElements()

updateAccessReturnElements

private void updateAccessReturnElements( $group, $modulename, $type )

  Updates

Parameter
$group
$modulename
$type
Returns void

See Also updateAccessReturn()

updateAccessElements

private void updateAccessElements( $group, $modulename, $type )

  Updates

Parameter
$group
$modulename
$type
Returns void

See Also updateAccessReturnElements()

Private Field Details

$modulegroup

private array $modulegroup

>>array()<<


$modulelist

private array $modulelist

>>array()<<


$undocumentedFields

private array $undocumentedFields

>>array( "functions" => "function", "uses" => "included file", "consts" => "constant" )<<

See Also findUndocumented()


Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta