Bug 17729 - Incorrect XML-docs warning about 'value' paramref
Summary: Incorrect XML-docs warning about 'value' paramref
Status: RESOLVED FIXED
Alias: None
Product: Xamarin Studio
Classification: Desktop
Component: Text Editor ()
Version: 4.2.3
Hardware: PC Mac OS
: Normal normal
Target Milestone: master
Assignee: Mike Krüger
URL:
Depends on:
Blocks:
 
Reported: 2014-02-12 12:25 UTC by Jeffrey Stedfast
Modified: 2014-02-12 13:55 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 Jeffrey Stedfast 2014-02-12 12:25:23 UTC
If you are writing xml docs for a c# property and need to reference the 'value' parameter, <paramref name="value"/> gets underlined as being incorrect when it seems to be perfectly valid according to csc.

Here's a screenshot of what I mean in case it's not clear: http://screencast.com/t/ol74nlAkCi
Comment 1 Mike Krüger 2014-02-12 12:43:52 UTC
For properties thats what the <value> tag is for.
I'll check it with csc what csc does with that.
Comment 2 Jeffrey Stedfast 2014-02-12 12:45:57 UTC
I thought <value> was the equivalent of <param name="value"> ? paramref is a bit different.

You may be right, it's really hard to get a straight answer reading the MSDN docs.
Comment 3 Mike Krüger 2014-02-12 13:55:59 UTC
I thought about using 

<summary>
If <value/> is null then ...
</summary>

- would've been a nice addition and would've been in line to the <value>description</value> tag. (But I think that this usage is invalid)

But the csc accepts the <paramref name="value"/> and that's the 'highest instance' in that case :)

/fixed