Bug #10454 incorrect return type documented for parameter collection Add methods
Submitted: 8 May 2005 23:15 Modified: 19 Jul 2005 20:00
Reporter: Mark Johnson (Basic Quality Contributor) Email Updates:
Status: Closed Impact on me:
None 
Category:Connector / NET Documentation Severity:S3 (Non-critical)
Version:1.0.4 OS:Windows (Windows 2000)
Assigned to: Reggie Burnett CPU Architecture:Any

[8 May 2005 23:15] Mark Johnson
Description:
All the Add methods of the MySqlParameterCollection class are documented as having the return value "The index of the new MySqlParameter object.".

However, only one of the Add methods returns an integer.  This one takes an Object as an argument.

The remaining Add methods return an object of type MySqlParameter.  Clearly, this is not the index of the MySqlParameter object, it is the MySqlParameter object itself.

How to repeat:
Check the source for the Parameter Collection class to see the return types.  Check the documentation to see what types are documented as being returned.

Suggested fix:
Update the Return Value part of the five incorrect Add methods to indicate that the MySqlParameter object is returned.
[14 Jul 2005 14:43] Reggie Burnett
Thank you for your bug report. This issue has been addressed in the
documentation. The updated documentation will appear on our website
shortly, and will be included in the next release of the relevant
product(s).