Bug #9174

@return and @param mistakes

Details

Doc Bug #9174	@return and @param mistakes
Submitted	2006-10-26 21:50 UTC
From	ja dot doma at gmail dot com
Assigned	quipo
Status	Closed
Package	MDB2
PHP Version	Irrelevant
Roadmaps	(Not assigned)

Comments

[2006-10-26 21:50 UTC] ja dot doma at gmail dot com

Description:
------------
Some methods, for example:
http://pear.php.net/package/MDB2/docs/latest/MDB2/MDB2_Driver_Common.html#methodloadModule

have additional bogus parameter. This is because of @param being used instead of @return. Looks like as a typo auto-completed by the editor (common mistake with auto-completions).

So if you ever going to read/check the documentation, then pay attention to the doc tags, please =)

I can correct all these mistakes, but I don't know how to commit these changes (diff/patch to e-mail?). English is not my native language, thus I can't check grammar/spelling.

Thanks!

Test script:
---------------
N/A

Expected result:
----------------
N/A

Actual result:
--------------
N/A

[2006-10-26 21:56 UTC] ja dot doma at gmail dot com

I think this should be moved to "feedback"... sorry =)