Packageindex Classtrees Modulegroups Elementlist Report XML Files

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

PhpdocAnalyser

PhpdocObject
   |
  +-- PhpdocAnalyser

Analyses parsing data.

 

private class PhpdocAnalyser extends PhpdocObject

Analyses parsing data.

Analyse means:
- update

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

 
Direct known subclasses: PhpdocClassAnalyser, PhpdocModuleAnalyser

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

Public Method Summary

void

analyse()

Starts the analysing of the raw parsing data.
boolean

updateAccessReturnElements()

Updates @access and @return for certain elements.

Private Method Summary

void

add_number_suffix(integer $nr)

Adds a suffix to the number like 1st, 2nd and 3th
void

updateBrothersSisters()

Handles @brother and @sister.
boolean

updateBrotherSisterElements()

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

updateAccessReturn()

Updates the @access and @return tag values.
void

updateAccessElements()

Updates @access tags.
void

checkFunctionArgs()

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

findUndocumented()

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

checkArgDocs(array $args, array $params, string $elname, string $elfile, [ boolean $inherited ])

Compares the argument list generated from the function head with the @param tags found.

Fields inherited from PhpdocObject

$err, $flag_output, $application, $warn

Private Field Summary

boolean

$flag_get

Flag indicating that getModule/getClass was called.

Public Method Details

analyse

public abstract void analyse( )

  Starts the analysing of the raw parsing data.

Returns void


updateAccessReturnElements

public abstract boolean updateAccessReturnElements( )

  Updates

Returns boolean $ok

See Also updateAccessReturn()

Private Method Details

add_number_suffix

private void add_number_suffix( integer $nr )

  Adds a suffix to the number like 1st, 2nd and 3th

Parameter
integer $nr
number to format
Returns void

Author(s) Thomas Weinert <subjective@subjective.de>

updateBrothersSisters

private abstract void updateBrothersSisters( )

  Handles

Returns void

See Also u::u

updateBrotherSisterElements

private boolean updateBrotherSisterElements( )

  Updates certain elements that use

Returns boolean $ok


updateAccessReturn

private abstract void updateAccessReturn( )

  Updates the

Returns void

See Also updateAccessReturnElements(), updateAccessElements()

updateAccessElements

private abstract void updateAccessElements( )

  Updates

Returns void

See Also updateAccessReturnElements()

checkFunctionArgs

private abstract void checkFunctionArgs( )

  Compares the

Returns void


findUndocumented

private abstract void findUndocumented( )

  Looks for undocumented elements and adds a warning if neccessary.

Returns void


checkArgDocs

private array checkArgDocs( array $args, array $params, string $elname, string $elfile, [ boolean $inherited ] )

  Compares the argument list generated from the function head with the

Parameter
array $args
Function arguments found by the parser
array $params
Paramarray
string $elname
Functionname
string $elfile
Filename
boolean $inherited = >>false<<
Param tags inherited?
Returns array $params

Param array


Private Field Details

$flag_get

private boolean $flag_get

>>false<<



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta