[Mono-bugs] [Bug 82381][Nor] New - Cannot put xml documentation on indexers in interfaces.

bugzilla-daemon at bugzilla.ximian.com bugzilla-daemon at bugzilla.ximian.com
Wed Aug 8 16:13:30 EDT 2007


Please do not reply to this email- if you want to comment on the bug, go to the
URL shown below and enter your comments there.

Changed by fizzfaldt at gmail.com.

http://bugzilla.ximian.com/show_bug.cgi?id=82381

--- shadow/82381	2007-08-08 16:13:30.000000000 -0400
+++ shadow/82381.tmp.20633	2007-08-08 16:13:30.000000000 -0400
@@ -0,0 +1,77 @@
+Bug#: 82381
+Product: Mono: Compilers
+Version: 1.2
+OS: 
+OS Details: Linux pacifico 2.6.9-55.0.2.ELsmp #1 SMP Tue Jun 12 17:58:20 EDT 2007 x86_64 x86_64 x86_64 GNU/Linux
+Status: NEW   
+Resolution: 
+Severity: 
+Priority: Normal
+Component: C#
+AssignedTo: rharinath at novell.com                            
+ReportedBy: fizzfaldt at gmail.com               
+QAContact: mono-bugs at ximian.com
+TargetMilestone: ---
+URL: 
+Cc: 
+Summary: Cannot put xml documentation on indexers in interfaces.
+
+Please fill in this template when reporting a bug, unless you know what you
+are doing.
+Description of Problem:
+When using /docs:
+XML Documentation of indexers inside of interfaces is not permitted.
+For a public interface, documentation is required for the indexer,
+but putting it there gives a false CS1587 warning.
+Exists in gmcs and mcs (version 1.2.4.0)
+
+Steps to reproduce the problem:
+1. use gmcs -doc:foo.xml xmlerror.cs
+
+Actual Results:
+xmlerror.cs(25,9): warning CS1587: XML comment is not placed on a valid
+language element
+
+Expected Results:
+Successful compilation, xml documentation should be generated.
+
+
+How often does this happen? 
+Always
+
+
+Additional Information:
+I do not know how the microsoft compiler handles this.
+
+Contents of xmlerror.cs:
+Additional code is here to show that similar things do not cause problems.
+
+<code>
+///<summary>summary</summary>
+public class blah
+{
+	///<summary>summary</summary>
+	public static int Main(string[] args)
+	{
+		return 0;
+	}
+}
+
+///<summary>summary</summary>
+public interface Interface
+{
+	//Having the following summary will give warning CS1587.
+	//Expected: Adds happily to XML documentation.
+	
+	//Not having it will give warning CS1591.
+	//Expected: Exactly that.
+	
+
+	///<summary>Problem!</summary>
+	int this[int index]
+	{
+		get;
+	}
+}
+
+</code>


More information about the mono-bugs mailing list