2004-07-02 Mike Kestner <mkestner@ximian.com>

* en/GLib/*.xml : more glib docs.

svn path=/trunk/gtk-sharp/; revision=30686

doc/ChangeLog

@@ -1,3 +1,7 @@
+2004-07-02  Mike Kestner  <mkestner@ximian.com>
+
+	* en/GLib/*.xml : more glib docs.
+
 2004-07-02  Mike Kestner  <mkestner@ximian.com>
 
 	* en/GLib/*.xml : docs for Boxed, ConnectBeforeAttribute, and 

doc/en/GLib/EnumWrapper.xml

@@ -28,8 +28,8 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>Indicates if the enum has the <see cref="T:System.FlagsAttribute" />.</summary>
-        <remarks>To be added</remarks>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName=".ctor">

doc/en/GLib/GException.xml

@@ -10,8 +10,8 @@
   </AssemblyInfo>
   <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
   <Docs>
-    <summary>To be added</summary>
+    <summary>Exception emitted by GError receipt from native methods.</summary>
-    <remarks>To be added</remarks>
+    <remarks>When a native method takes a GError parameter to report failures in method invocation, if the GError parameter is set after method invocation this Exception is thrown to report the error.</remarks>
   </Docs>
   <Base>
     <BaseTypeName>System.Exception</BaseTypeName>
@@ -43,10 +43,10 @@
         <Parameter Name="errptr" Type="System.IntPtr" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>Internal constructor.</summary>
-        <param name="errptr">an object of type <see cref="T:System.IntPtr" /></param>
+        <param name="errptr">a handle to the native GError pointer.</param>
         <returns>an object of type <see cref="T:GLib.GException" /></returns>
-        <remarks>To be added</remarks>
+        <remarks>This constructor is public so that generated code in assemblies outside of glib-sharp.dll can access it, but it should not be necessary to use it from application code.</remarks>
       </Docs>
     </Member>
     <Member MemberName="Message">
@@ -57,9 +57,9 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>The error text contained in the native GError.</summary>
-        <returns>a <see cref="T:System.String" /></returns>
+        <returns>a <see cref="T:System.String" /> representing the error message contained in the native GError.</returns>
-        <remarks>To be added</remarks>
+        <remarks />
       </Docs>
     </Member>
   </Members>

doc/en/GLib/GType.xml

@@ -245,7 +245,7 @@ public class MagrittesWindow : Window {
         </summary>
         <param name="o">a <see cref="T:System.Object" /></param>
         <returns>a <see cref="T:System.Boolean" /></returns>
-        <remarks>To be added</remarks>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName="GetHashCode">

doc/en/GLib/IWrapper.xml

@@ -10,8 +10,8 @@
   </AssemblyInfo>
   <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
   <Docs>
-    <summary>To be added</summary>
+    <summary>Interface to identify a handle accessible wrapped type.</summary>
-    <remarks>To be added</remarks>
+    <remarks>This interface is used by the code generator, but it not typically used by application code.</remarks>
   </Docs>
   <Base />
   <Interfaces />
@@ -24,9 +24,9 @@
         <ReturnType>System.IntPtr</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added</summary>
+        <summary>A pointer to the native type instance.</summary>
         <returns>an object of type <see cref="T:System.IntPtr" /></returns>
-        <remarks>To be added</remarks>
+        <remarks />
       </Docs>
     </Member>
   </Members>

doc/en/GLib/Idle.xml

@@ -69,10 +69,10 @@
         <Parameter Name="hndlr" Type="GLib.IdleHandler" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>Removes an Idle handler from the Main Loop.</summary>
-        <param name="hndlr">a <see cref="T:GLib.IdleHandler" /></param>
+        <param name="hndlr">an <see cref="T:GLib.IdleHandler" /> to remove.</param>
         <returns>a <see cref="T:System.Boolean" /></returns>
-        <remarks>To be added</remarks>
+        <remarks />
       </Docs>
     </Member>
   </Members>

doc/en/GLib/ListBase.xml

@@ -44,8 +44,9 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>The <see cref="T:System.Type" /> of the elements of the list.</summary>
-        <remarks>To be added</remarks>
+        <remarks>
+          <see cref="T:GLib.Object" /> subclasses are handled automatically, so it is not necessary to set this field for lists of <see cref="T:GLib.Object" />.</remarks>
       </Docs>
     </Member>
     <Member MemberName="Clone">
@@ -154,9 +155,9 @@
         <ReturnType>System.Object</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added</summary>
+        <summary>Synchronization root.</summary>
-        <returns>an object of type <see cref="T:System.Object" /></returns>
+        <returns>always <see langword="null" /></returns>
-        <remarks>To be added</remarks>
+        <remarks>Always returns <see langword="null" /> since this type is never synchronized.</remarks>
       </Docs>
     </Member>
     <Member MemberName="IsSynchronized">
@@ -166,9 +167,9 @@
         <ReturnType>System.Boolean</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added</summary>
+        <summary>Indicates if the list is synchronized.</summary>
-        <returns>an object of type <see cref="T:System.Boolean" /></returns>
+        <returns>always <see langword="false" /></returns>
-        <remarks>To be added</remarks>
+        <remarks>Always returns false. </remarks>
       </Docs>
     </Member>
     <Member MemberName="Count">
@@ -178,9 +179,9 @@
         <ReturnType>System.Int32</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added</summary>
+        <summary>The number of elements in the list.</summary>
-        <returns>an object of type <see cref="T:System.Int32" /></returns>
+        <returns>the number of elements in the list as an <see cref="T:System.Int32" /></returns>
-        <remarks>To be added</remarks>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName="Handle">
@@ -205,10 +206,10 @@
       <Parameters>
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>Indicates if the native handle is owned by the Managed list class.</summary>
         <param name="value">an object of type <see cref="T:System.Boolean" /></param>
         <returns>an object of type <see cref="T:System.Boolean" /></returns>
-        <remarks>To be added</remarks>
+        <remarks>Identifies the list as one that needs to be freed.  Only set this to true if you want the object to release the associated native list when it is disposed.</remarks>
       </Docs>
     </Member>
     <Member MemberName="GetEnumerator">
@@ -249,10 +250,10 @@
         <Parameter Name="index" Type="System.Int32" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>Indexer for list members.</summary>
-        <param name="index">a <see cref="T:System.Int32" /></param>
+        <param name="index">a <see cref="T:System.Int32" /> representing the 0 indexed offset to the member.</param>
-        <returns>a <see cref="T:System.Object" /></returns>
+        <returns>the list member at <paramref name="index" /> as an <see cref="T:System.Object" />.</returns>
-        <remarks>To be added</remarks>
+        <remarks />
       </Docs>
     </Member>
   </Members>