Move the general info into ns-...xml so monodoc can display it.

svn path=/trunk/mcs/; revision=158544

diff --git a/mcs/class/Mono.Debugger.Soft/Documentation/en/index.xml b/mcs/class/Mono.Debugger.Soft/Documentation/en/index.xml
index 86f1f2dca3375c296ef534a4faee663d071e784a..0e514e8717250e7992e33d48b60c64e4f8c9efc0 100644 (file)
--- a/mcs/class/Mono.Debugger.Soft/Documentation/en/index.xml
+++ b/mcs/class/Mono.Debugger.Soft/Documentation/en/index.xml
@@ -8,19 +8,6 @@
       </Attributes>
     </Assembly>
   </Assemblies>
-  <Remarks>
-    <para>This API is used to communicate with the debugging agent running 
-       inside a mono runtime.
-       </para>
-    <para>The API is based on and is very similar to the <format type="text/html"><a href="http://java.sun.com/j2se/1.5.0/docs/guide/jpda/jdi/index.html">Java Debug Interface.</a> If documentation is missing, the JDI documentation can be consulted instead.</format></para>
-    <para>
-       In this documentation, debuggee refers to the remote process running the mono runtime which this API communicates with.
-       </para>
-    <para>A <c>Mirror</c> object represents an entity in the debuggee. There is usually one mirror subclass for each type of entity, i.e. <c>TypeMirror</c> for types, <c>AppDomainMirror</c> for application domains etc. These classes usually have a similar set of properties/methods as their non-mirror counterparts, the difference is that calling these properties/methods might result in a remote call to the debuggee to request information. The results of these remote calls are usually cached in the mirror object, so when multiple calls are made to <c>TypeMirror.Name</c>, for example, only the first call involves a remote operation. The <c>ToString()/Equals()/GetHashCode ()</c> methods are an exception, these are guaranteed to only access local state.
-       </para>
-    <para>Differences between this API and JDI:
-       <list type="bullet"><item><term>There is only one namespace, instead of 5 in JDI.</term></item><item><term>The API uses classes, while JDI uses interfaces.</term></item><item><term>No SPI interface yet.</term></item><item><term>Information is accessed using C# properties instead of methods.</term></item><item><term>There are fewer classes, i.e. <c>EventQueue</c>/<c>EventRequestManager</c> is integrated into <c>VirtualMachine</c>.</term></item><item><term>Values which have primitive types i.e. int are represented by a class called <c>PrimitiveValue</c>, instead of a separate class for each primitive type.</term></item></list></para>
-  </Remarks>
   <Copyright>(C) 2009 Novell, Inc.</Copyright>
   <Types>
     <Namespace Name="Mono.Debugger.Soft">

diff --git a/mcs/class/Mono.Debugger.Soft/Documentation/en/ns-Mono.Debugger.Soft.xml b/mcs/class/Mono.Debugger.Soft/Documentation/en/ns-Mono.Debugger.Soft.xml
index 46c02c402babc6c7b745b025e3f2856ffe1367ae..e658bfc9991ef0234b4368d4dded0dc26892a858 100644 (file)
--- a/mcs/class/Mono.Debugger.Soft/Documentation/en/ns-Mono.Debugger.Soft.xml
+++ b/mcs/class/Mono.Debugger.Soft/Documentation/en/ns-Mono.Debugger.Soft.xml
@@ -1,4 +1,18 @@
 <Namespace Name="Mono.Debugger">
   <Docs>
+       <summary>Mono Soft Debugger API</summary>
+  <remarks>
+    <para>This API is used to communicate with the debugging agent running 
+       inside a mono runtime.
+       </para>
+    <para>The API is based on and is very similar to the <format type="text/html"><a href="http://java.sun.com/j2se/1.5.0/docs/guide/jpda/jdi/index.html">Java Debug Interface.</a> If documentation is missing, the JDI documentation can be consulted instead.</format></para>
+    <para>
+       In this documentation, debuggee refers to the remote process running the mono runtime which this API communicates with.
+       </para>
+    <para>A <c>Mirror</c> object represents an entity in the debuggee. There is usually one mirror subclass for each type of entity, i.e. <c>TypeMirror</c> for types, <c>AppDomainMirror</c> for application domains etc. These classes usually have a similar set of properties/methods as their non-mirror counterparts, the difference is that calling these properties/methods might result in a remote call to the debuggee to request information. The results of these remote calls are usually cached in the mirror object, so when multiple calls are made to <c>TypeMirror.Name</c>, for example, only the first call involves a remote operation. The <c>ToString()/Equals()/GetHashCode ()</c> methods are an exception, these are guaranteed to only access local state.
+       </para>
+    <para>Differences between this API and JDI:
+       <list type="bullet"><item><term>There is only one namespace, instead of 5 in JDI.</term></item><item><term>The API uses classes, while JDI uses interfaces.</term></item><item><term>No SPI interface yet.</term></item><item><term>Information is accessed using C# properties instead of methods.</term></item><item><term>There are fewer classes, i.e. <c>EventQueue</c>/<c>EventRequestManager</c> is integrated into <c>VirtualMachine</c>.</term></item><item><term>Values which have primitive types i.e. int are represented by a class called <c>PrimitiveValue</c>, instead of a separate class for each primitive type.</term></item></list></para>
+  </remarks>
   </Docs>
 </Namespace>