Package home | Report new bug | New search | Development Roadmap Status: Open | Feedback | All | Closed Since Version 1.5.0a1

Doc Bug #14312 @param tag with additional arguments doesn't work as expected
Submitted: 2008-07-08 20:00 UTC
From: panamajo Assigned: ashnazg
Status: Closed Package: PhpDocumentor (version 1.4.2)
PHP Version: 5.2.6 OS: Linux
Roadmaps: 1.4.3    
Subscription  
Comments Add Comment Add patch


Anyone can comment on a bug. Have a simpler test case? Does it work for you on a different platform? Let us know! Just going to say 'Me too!'? Don't clutter the database with that please !
Your email address:
MUST BE VALID
Solve the problem : 31 - 10 = ?

 
 [2008-07-08 20:00 UTC] panamajo (Jo Schulze)
Description: ------------ I am using PhpDocumentor to generate HTML docs (phpdoc ... -o HTML:Smarty:HandS). The results do differ from the expected (in this case I am referring to <http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.param.pkg.html>) Maybe it's only a documentation problem. Best results when documenting the source like this: /** * @param string $text ,... string to translate, optional additional arguments * @return string translation */ function i18n ($text) ... NOTE: there is a blank between $text and ,... Test script: --------------- /** * @param string $text string to translate * @param string $text,... optional additional arguments * @return string translation */ function i18n ($text) { return(foo($text)); } Expected result: ---------------- The documentation should display the function prototype like this: string i18n( string $text,... ) Actual result: -------------- string i18n( string $text, string $text,... ) Note that this implies that at least 2 params are mandatory which is totally wrong.

Comments

 [2008-07-26 13:38 UTC] doconnor (Daniel O'Connor)
Doc problem or bug?
 [2009-06-02 03:28 UTC] ashnazg (Chuck Burgess)
-Status: Open +Status: Assigned -Assigned To: +Assigned To: ashnazg -Roadmap Versions: +Roadmap Versions: 1.4.3
 [2009-06-02 03:29 UTC] ashnazg (Chuck Burgess)
-Status: Assigned +Status: Closed
Added verbiage to the PARAM docs to clarify usage of the "$paramname,..." syntax.
 [2009-06-02 03:29 UTC] ashnazg (Chuck Burgess)
Changes committed to CVS. Look for the manual to be updated with the release of v1.4.3.