PHPDOC 2000/12/03 - PHPDoc

PhpdocModuleAnalyser

PhpdocObject
   |
  +-- PhpdocAnalyser
     |
    +-- PhpdocModuleAnalyser

Analyses a modulegroup.

private class PhpdocModuleAnalyser extends PhpdocAnalyser

Analyses a modulegroup.

Authors Ulf Wendel <ulf.wendel@phpdoc.de>

Version $Id: $

Methods inherited from PhpdocAnalyser

addnumbersuffix, copybrothersisterfields, checkseeelement, 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.
boolean	updateBrotherSisterElements(string $group, string $modulename, string $type) Warning: documentation is missing.
boolean	updateAccessReturnElements(string $group, string $modulename, string $type) Warning: documentation is missing.
boolean	updateAccessElements(string $group, string $modulename, string $type) Warning: documentation is missing.
void	checkSeeElements(array $elements, string $modulegroup, string $modulename, string $eltype) Checks see references in the given element array (functions, variables...)
void	buildElementlist(string $modulegroup, string $modulename) Builds an array with all elements of a class and saves it to $this->elementlist.Warning: documentation is missing.
void	analyse() Starts the analysing of the raw parsing data.Warning: documentation is missing.
void	findUndocumented() Looks for undocumented elements and adds a warning if neccessary.Warning: documentation is missing.
void	checkFunctionArgs() Compares the param tags with the function head found.Warning: documentation is missing.
void	updateBrothersSisters() Handles brother and sister.Warning: documentation is missing.
void	updateAccessReturn() Updates the access and return tag values.Warning: documentation is missing.
void	checkSee() Checks all see references in the given classes/modulegroup.Warning: documentation is missing.

Fields inherited from PhpdocAnalyser

$flag_get, $elementlist

Fields inherited from PhpdocObject

$err, $application, $warn, $flag_output

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

updateBrotherSisterElements

private boolean updateBrotherSisterElements( string $group, string $modulename, string $type )

Warning: documentation is missing.

Parameter

string	$group

string	$modulename

string	$type
	: functions, variables.

Returns

boolean

updateAccessReturnElements

private boolean updateAccessReturnElements( string $group, string $modulename, string $type )

Warning: documentation is missing.

Parameter

string	$group

string	$modulename

string	$type
	: functions, variables, consts.

Returns

boolean

updateAccessElements

private boolean updateAccessElements( string $group, string $modulename, string $type )

Warning: documentation is missing.

Parameter

string	$group

string	$modulename

string	$type
	: functions, variables, consts.

Returns

boolean

checkSeeElements

private void checkSeeElements( array $elements, string $modulegroup, string $modulename, string $eltype )

Checks see references in the given element array (functions, variables...)
References to variables and functions within the same module get checked.It the references element does not exist, the reference gets deleted anda doc warning gets generated.

Parameter

array	$elements
	of functions, variables,...

string	$modulegroup
	of the modulegroup that contains the given elements.

string	$modulename
	of the module that contains the given elements.

string	$eltype
	: functions, variables, consts, uses.

Returns

void

buildElementlist

private void buildElementlist( string $modulegroup, string $modulename )

Builds an array with all elements of a class and saves it to $this->elementlist.

Warning: documentation is missing.

Parameter

string	$modulegroup
	of the modulegroup that contains the module.

string	$modulename
	of the module to scan.

Returns

void

analyse

private void analyse( )

Starts the analysing of the raw parsing data.

Warning: documentation is missing.

Returns

void

findUndocumented

private void findUndocumented( )

Looks for undocumented elements and adds a warning if neccessary.

Warning: documentation is missing.

Returns

void

checkFunctionArgs

private void checkFunctionArgs( )

Compares the param tags with the function head found.

Warning: documentation is missing.

Returns

void

updateBrothersSisters

private void updateBrothersSisters( )

Handles brother and sister.

Warning: documentation is missing.

Returns

void

updateAccessReturn

private void updateAccessReturn( )

Updates the access and return tag values.

Warning: documentation is missing.

Returns

void

See Also updateAccessReturnElements(), updateAccessElements()

checkSee

private void checkSee( )

Checks all see references in the given classes/modulegroup.

Warning: documentation is missing.

Returns

void

Private Field Details
$modulegroup
private array $modulegroup >>`array()`<< Module data

$modulelist
private array $modulelist >>`array()`<< List of all modules in the modulegroup

$undocumentedFields
private array $undocumentedFields >>`array( "functions" => "function", "uses" => "included file", "consts" => "constant" )`<< Puuuh - findUndocumented() needs this.
See Also	findUndocumented()

PHPDoc 1.0beta

PHPDOC 2000/12/03 - PHPDoc

PhpdocModuleAnalyser

private class PhpdocModuleAnalyser extends PhpdocAnalyser

Methods inherited from PhpdocAnalyser

Methods inherited from PhpdocObject

Public Method Summary

setModulegroup(array $modulegroup)

getModule()

Private Method Summary

buildModulelist()

updateBrotherSisterElements(string $group, string $modulename, string $type)

updateAccessReturnElements(string $group, string $modulename, string $type)

updateAccessElements(string $group, string $modulename, string $type)

checkSeeElements(array $elements, string $modulegroup, string $modulename, string $eltype)

buildElementlist(string $modulegroup, string $modulename)

analyse()

findUndocumented()

checkFunctionArgs()

updateBrothersSisters()

updateAccessReturn()

checkSee()

Fields inherited from PhpdocAnalyser

Fields inherited from PhpdocObject

Private Field Summary

$modulegroup

$modulelist

$undocumentedFields

Public Method Details

setModulegroup

getModule

Private Method Details

buildModulelist

updateBrotherSisterElements

updateAccessReturnElements

updateAccessElements

checkSeeElements

buildElementlist

analyse

findUndocumented

checkFunctionArgs

updateBrothersSisters

updateAccessReturn

checkSee

Private Field Details

$modulegroup

$modulelist

$undocumentedFields