[Mono-bugs] [Bug 82565][Nor] New - Bad xml doc comments results in unhelpful errors

[bugzilla-daemon at bugzilla.ximian.com]

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 jesjones at mindspring.com.

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

--- shadow/82565	2007-08-24 05:44:39.000000000 -0400
+++ shadow/82565.tmp.15024	2007-08-24 05:44:39.000000000 -0400
@@ -0,0 +1,55 @@
+Bug#: 82565
+Product: Mono: Compilers
+Version: 1.2
+OS: 
+OS Details: 
+Status: NEW   
+Resolution: 
+Severity: 
+Priority: Normal
+Component: C#
+AssignedTo: rharinath at novell.com                            
+ReportedBy: jesjones at mindspring.com               
+QAContact: mono-bugs at ximian.com
+TargetMilestone: ---
+URL: 
+Cc: 
+Summary: Bad xml doc comments results in unhelpful errors
+
+Description of Problem:
+/// comments that are badly formatted result in error messages that contain
+no hint of the actual problem or the location of the problem. 
+
+Steps to reproduce the problem:
+Compile the code below with the -doc option.
+
+Actual Results:
+Error CS1569: Error generating XML documentation file `foo.xml' (`Cannot
+insert specified type of node as a child of this node.')
+
+Expected Results:
+Some sort of hint as to the location of the problem, the file, class,
+member, whatever.
+
+How often does this happen? 
+Always.
+
+Additional Information:
+---- snip -------------------------
+using System;
+
+/// Text goes here.
+///
+/// <?xml version = "1.0" encoding = "utf-8" ?>
+/// <configuration>
+///     <appSettings>
+///         <add key = "blah" value = "blech"/>
+///     </appSettings>
+/// </configuration> 
+public class Test
+{    
+    public void Work(string f)
+    {
+        Console.WriteLine(f);
+    }
+}