@param --
describes a parameter of a function
Note
PHPDoc detects default values and document
them from source.
Example
...
* @param string $name name of the person
* (complete name!)
* @param integer $age age of the person
* @param float $size size of person
* @param object Adresse $adr adresse of the person
* @param array $childs names of the children
* @param boolean $job if true, person has a job
* @param boolean $gender use FEMALE
* or MALE
*/
function person($name, $age, $size,
$adr, $childs, $job=true,
$gender=FEMALE) {
... |