Private Method Details |
addNumberSuffix |
|
private string addNumberSuffix( integer $nr )
|
| |
Adds a suffix to the number like 1st, 2nd and 3th
|
| Parameter |
|
| integer |
$nr |
|
|
number to format |
|
| Returns |
string |
| Author(s) |
Thomas Weinert <subjective@subjective.de> |
|
updateBrothersSisters |
|
private abstract void updateBrothersSisters( )
|
| |
Handles brother and sister.
|
| Returns |
void |
| See Also |
updateBrotherSisterElements() |
|
updateBrotherSisterElements |
|
private boolean updateBrotherSisterElements( )
|
| |
Updates certain elements that use brother and sister.
|
| Returns |
boolean $ok |
|
copyBrotherSisterFields |
|
private void copyBrotherSisterFields( array $target, array $from )
|
| |
Copies fields from a brother or sister to the current element.
|
| Parameter |
|
| array |
$target |
|
|
of the target element that has a brother/sister tag |
|
|
| array |
$from |
|
|
of the element that is referenced by brother/sister |
|
| Returns |
void |
|
updateAccessReturn |
|
private abstract void updateAccessReturn( )
|
| |
Updates the access and return tag values.
|
| Returns |
void |
| See Also |
updateAccessReturnElements(), updateAccessElements() |
|
updateAccessReturnElements |
|
private abstract boolean updateAccessReturnElements( )
|
| |
Updates access and return for certain elements.
This function should only be used to update functions.Functions that have the same name as the class (constructors)get return void and access public. Functions withoutaccess get access public and functions without return get return void.
|
| Returns |
boolean $ok |
| See Also |
updateAccessReturn() |
|
updateAccessElements |
|
private abstract void updateAccessElements( )
|
| |
Updates access tags.
|
| Returns |
void |
| See Also |
updateAccessReturnElements() |
|
checkFunctionArgs |
|
private abstract void checkFunctionArgs( )
|
| |
Compares the param tags with the function head found.
|
| Returns |
void |
|
findUndocumented |
|
private abstract void findUndocumented( )
|
| |
Looks for undocumented elements and adds a warning if neccessary.
|
| Returns |
void |
|
checkSee |
|
private abstract void checkSee( )
|
| |
Checks all see references in the given classes/modulegroup.
|
| Returns |
void |
|
checkSeeElement |
|
private abstract void checkSeeElement( )
|
| |
Checks see references in the given elementlist.
|
| Returns |
void |
|
buildElementlist |
|
private abstract void buildElementlist( )
|
| |
Build a list of all elemente (functions, variables,...) of a certain class/module
|
| Returns |
void |
| See Also |
$elementlist |
|
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 param tags found.
PHPDoc is able to recognize these documentation mistakes:- too few or too many param tags- name does not match or is missing- type does not match or is missing- trouble with inherited elements
|
| Parameter |
|
| array |
$args |
|
|
arguments found by the parser |
|
|
|
|
|
|
|
|
| boolean |
$inherited |
= >>false<< |
|
tags inherited? |
|
| Returns |
array $params Param array |
|