| Package home | Report new bug | New search | Development Roadmap | Status: Open | Feedback | All | Closed Since Version 1.5.0a1 |
| Bug #8290 | @param bug when description is on its own line | ||
|---|---|---|---|
| Submitted: | 2006-07-25 20:10 UTC | ||
| From: | none at none dot none | Assigned: | cellog |
| Status: | Closed | Package: | PhpDocumentor (version 1.3.0RC6) |
| PHP Version: | 5.1.4 | OS: | Windows XP SP2 |
| Roadmaps: | (Not assigned) | ||
[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
Comments
[2006-08-16 17:38 UTC] User who submitted this comment has not confirmed identity
If you submitted this note, check your email.If you do not have a message, click here to re-send MANUAL CONFIRMATION IS NOT POSSIBLE. Write a message to pear-dev@lists.php.net to request the confirmation link. All bugs/comments/patches associated with this email address will be deleted within 48 hours if the account request is not confirmed!