Bug 6020 - Incorrect default comments...
Summary: Incorrect default comments...
Status: RESOLVED FIXED
Alias: None
Product: Xamarin Studio
Classification: Desktop
Component: Text Editor ()
Version: 3.0.x
Hardware: Macintosh Mac OS
: Low normal
Target Milestone: ---
Assignee: Mike Krüger
URL:
Depends on:
Blocks:
 
Reported: 2012-07-06 15:39 UTC by Justin
Modified: 2012-07-09 07:02 UTC (History)
1 user (show)

Tags:
Is this bug a regression?: ---
Last known good build:

Notice (2018-05-24): bugzilla.xamarin.com is now in read-only mode.

Please join us on Visual Studio Developer Community and in the Xamarin and Mono organizations on GitHub to continue tracking issues. Bugzilla will remain available for reference in read-only mode. We will continue to work on open Bugzilla bugs, copy them to the new locations as needed for follow-up, and add the new items under Related Links.

Our sincere thanks to everyone who has contributed on this bug tracker over the years. Thanks also for your understanding as we make these adjustments and improvements for the future.


Please create a new report on Developer Community or GitHub with your current version information, steps to reproduce, and relevant error messages or log files if you are hitting an issue that looks similar to this resolved bug and you do not yet see a matching new report.

Related Links:
Status:
RESOLVED FIXED

Description Justin 2012-07-06 15:39:10 UTC
Given this method signature:
public bool RemoveReport(ReportInfo info)

The default docs generated when typing /// are incorrect:

/// <summary>
/// Removes the report.
/// </summary>
/// <returns>
/// The report.
/// </returns>
/// <param name='info'>
/// If set to <c>true</c> info.
/// </param>

Notice that it says it returns "The report" but the return type is a bool...

Also notice that the comment for the info param seems to indicate the paramter is a bool, even though it is a ReportInfo object.

It seems like it got confused and swapped the types of the parameter and return types...
Comment 1 Mike Krüger 2012-07-09 07:02:35 UTC
fixed.