PEAR is archived and read-only

This mirror preserves historical PEAR package releases and metadata so existing references remain available.

Home » Tools and Utilities » PhpDocumentor » Bug #8290

@param bug when description is on its own line

Details

Submitted2006-07-25 20:10 UTC
Fromnone at none dot none
Assignedcellog
StatusClosed
PackagePhpDocumentor
PHP Version5.1.4
OSWindows XP SP2
Roadmaps(Not assigned)

Comments

[2006-07-25 20:10 UTC] none at none dot none

Description:
------------
If the entire "description" part of a param tag on its own line (i.e., there is nothing or only whitespace after the parameter name until the end of the line), then it is treated as an unlisted parameter with the same name as the listed parameter. So then it looks like there are two of each parameter that is commented in this way, only one of which has a description.

Test script:
---------------
<?php
/**
* @param integer $hi
* This is the description.
*/
function test($hi) {
}
?>

Expected result:
----------------
In the documentation for test():

void test ( integer $hi )
* integer $hi : This is the description.

Actual result:
--------------
In the documentation for test():

void test ( $hi, integer $hi )
* integer $hi : This is the description.
* $hi