| Package home | Report new bug | New search | Development Roadmap | Status: Open | Feedback | All | Closed Since Version 1.3.8 |
| Request #8171 | Add return types & description (phpDocumentor) | ||
|---|---|---|---|
| Submitted: | 2006-07-10 04:04 UTC | ||
| From: | exacube at gmail dot com | Assigned: | cweiske |
| Status: | Closed | Package: | Net_POP3 (version 1.3.6) |
| PHP Version: | 5.1.4 | OS: | Linux (on PowerPC) |
| Roadmaps: | (Not assigned) | ||
[2006-07-10 04:04 UTC] exacube at gmail dot com
(vardhan)
Description:
------------
i'm not exactly that familiar with phpDocumentor, but it seems that the current documentation for Net_POP3 doesn't have the proper return types. Further more, the descriptions that have been provided in the POP3.php file aren't showing up. Can someone fix this?
For example, insted of:
getBody [line 744]
void getBody( mixed $msg_id)
It would be nice to have
getBody [line 744]
mixed getBody( mixed $msg_id)
And again, a description of what the method/function is supposed to perform, and the description of all the return values would be nice.
Comments
[2007-03-27 10:58 UTC] cweiske
(Christian Weiske)
This bug has been fixed in CVS.
If this was a documentation problem, the fix will appear on pear.php.net by the end of next Sunday (CET).
If this was a problem with the pear.php.net website, the change should be live shortly.
Otherwise, the fix will appear in the package's next release.
Thank you for the report and for helping us make PEAR better.
The comments where there, but they had "/*" only instead of "/**"