From bafd35ea5e9982b37bdba99cee76cd733a46f333 Mon Sep 17 00:00:00 2001
From: John Luke <jluke@mono-cvs.ximian.com>
Date: Wed, 12 Nov 2003 06:07:52 +0000
Subject: [PATCH] 2003-11-12  John Luke  <jluke@cfl.rr.com>

	* en/Gtk/Quit.xml: documented
	* en/Gtk/TooltipsData.xml: documented
	* en/Gtk/TODO: update

svn path=/trunk/gtk-sharp/; revision=19864
---
 doc/ChangeLog               |  6 ++++
 doc/en/Gtk/Quit.xml         | 36 ++++++++++++----------
 doc/en/Gtk/TODO             |  5 +---
 doc/en/Gtk/TooltipsData.xml | 59 +++++++++++++++++++------------------
 4 files changed, 58 insertions(+), 48 deletions(-)

diff --git a/doc/ChangeLog b/doc/ChangeLog
index 88a0db33a..3abe636b7 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,9 @@
+2003-11-12  John Luke  <jluke@cfl.rr.com>
+
+	* en/Gtk/Quit.xml: documented
+	* en/Gtk/TooltipsData.xml: documented
+	* en/Gtk/TODO: update
+	
 2003-11-05  Mike Kestner  <mkestner@ximian.com>
 
 	* en/Gtk/NodeStore.xml : documented
diff --git a/doc/en/Gtk/Quit.xml b/doc/en/Gtk/Quit.xml
index 5b0c74c7e..6910a57b8 100644
--- a/doc/en/Gtk/Quit.xml
+++ b/doc/en/Gtk/Quit.xml
@@ -1,8 +1,9 @@
 <Type Name="Quit" FullName="Gtk.Quit">
-  <TypeSignature Language="C#" Value="public class Quit" Maintainer="auto" />
+  <TypeSignature Language="C#" Value="public class Quit" Maintainer="John Luke" />
   <AssemblyInfo>
     <AssemblyName>gtk-sharp</AssemblyName>
-    <AssemblyPublicKey></AssemblyPublicKey>
+    <AssemblyPublicKey>
+    </AssemblyPublicKey>
     <AssemblyVersion>0.0.0.0</AssemblyVersion>
     <AssemblyCulture>neutral</AssemblyCulture>
     <Attributes />
@@ -10,7 +11,7 @@
   <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>
-    <remarks>To be added</remarks>
+    <remarks></remarks>
   </Docs>
   <Base>
     <BaseTypeName>System.Object</BaseTypeName>
@@ -28,9 +29,9 @@
         <Parameter Name="quit_handler_id" Type="System.UInt32" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>Removes a quit handler by its identifier.</summary>
         <param name="quit_handler_id">a <see cref="T:System.UInt32" /></param>
-        <remarks>To be added</remarks>
+        <remarks></remarks>
       </Docs>
     </Member>
     <Member MemberName="Add">
@@ -44,11 +45,11 @@
         <Parameter Name="function" Type="Gtk.Function" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>Registers a function to be called when an instance of the mainloop is left.</summary>
         <param name="main_level">a <see cref="T:System.UInt32" /></param>
         <param name="function">a <see cref="T:Gtk.Function" /></param>
         <returns>a <see cref="T:System.UInt32" /></returns>
-        <remarks>To be added</remarks>
+        <remarks></remarks>
       </Docs>
     </Member>
     <Member MemberName="AddFull">
@@ -65,14 +66,17 @@
         <Parameter Name="destroy" Type="Gtk.DestroyNotify" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>Registers a function to be called when an instance of the mainloop is left.</summary>
         <param name="main_level">a <see cref="T:System.UInt32" /></param>
         <param name="function">a <see cref="T:Gtk.Function" /></param>
         <param name="marshal">a <see cref="T:Gtk.CallbackMarshal" /></param>
         <param name="data">a <see cref="T:System.IntPtr" /></param>
         <param name="destroy">a <see cref="T:Gtk.DestroyNotify" /></param>
         <returns>a <see cref="T:System.UInt32" /></returns>
-        <remarks>To be added</remarks>
+        <remarks>
+          <para>In comparison to <see cref="M:Gtk.Quit.Add()" /> this function adds the possibility to pass a marshaller and a function to be called when the quit handler is freed.</para>
+          <para>The former can be used to run interpreted code instead of a compiled function while the latter can be used to free the information stored in data.</para>
+		</remarks>
       </Docs>
     </Member>
     <Member MemberName="RemoveByData">
@@ -85,9 +89,9 @@
         <Parameter Name="data" Type="System.IntPtr" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>Removes a quit handler identified by its <paramref name="data" /> field.</summary>
         <param name="data">a <see cref="T:System.IntPtr" /></param>
-        <remarks>To be added</remarks>
+        <remarks></remarks>
       </Docs>
     </Member>
     <Member MemberName="AddDestroy">
@@ -101,10 +105,10 @@
         <Parameter Name="objekt" Type="Gtk.Object" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>Trigger destruction of <paramref name="objekt" /> in case the mainloop at level <paramref name="main_level" /> is quit.</summary>
         <param name="main_level">a <see cref="T:System.UInt32" /></param>
         <param name="objekt">a <see cref="T:Gtk.Object" /></param>
-        <remarks>To be added</remarks>
+        <remarks></remarks>
       </Docs>
     </Member>
     <Member MemberName=".ctor">
@@ -113,10 +117,10 @@
       <ReturnValue />
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>Default Constructor</summary>
         <returns>a <see cref="T:Gtk.Quit" /></returns>
-        <remarks>To be added</remarks>
+        <remarks></remarks>
       </Docs>
     </Member>
   </Members>
-</Type>
\ No newline at end of file
+</Type>
diff --git a/doc/en/Gtk/TODO b/doc/en/Gtk/TODO
index aebee23bd..5e4934c99 100644
--- a/doc/en/Gtk/TODO
+++ b/doc/en/Gtk/TODO
@@ -1,6 +1,6 @@
 TODO doc for Gtk namespace.
 
-There are in total 324 xml to document in Gtk. Right now there are 176 xml not documented in any proportion.
+There are in total 324 xml to document in Gtk. Right now there are 173 xml not documented in any proportion.
 The idea is to have a easy way to know what documentation is missing, if you want to help or are helping please take out the xml that you commit
 from the missing list. For documentation that take some time to finish (like HTML, TextBuffer, etc) the best is that you but your name and email
 next to the file in this list to acknowledge that you are working in it (is recommendable that you suscribe to the mono-docs  mailing list).
@@ -90,7 +90,6 @@ Paint.xml
 PathPriorityType.xml
 PathType.xml
 PrintFunc.xml
-Quit.xml
 RBNode.xml
 RBNodeColor.xml
 RBTree.xml
@@ -156,7 +155,6 @@ ThemeEngine.xml
 ThreadNotify.xml
 ToolbarChildType.xml
 ToolbarSpaceStyle.xml
-TooltipsData.xml
 TranslateFunc.xml
 Tree.xml
 TreeCellDataFunc.xml
@@ -181,5 +179,4 @@ TreeViewMappingFunc.xml
 TreeViewSeachEqualFunc.xml
 Visibility.xml
 WidgetHelpType.xml
-WindowGroup.xml
 WindowKeysForeachFunc.xml
diff --git a/doc/en/Gtk/TooltipsData.xml b/doc/en/Gtk/TooltipsData.xml
index dc7a545d6..4655fbf94 100644
--- a/doc/en/Gtk/TooltipsData.xml
+++ b/doc/en/Gtk/TooltipsData.xml
@@ -1,16 +1,17 @@
 <Type Name="TooltipsData" FullName="Gtk.TooltipsData">
-  <TypeSignature Language="C#" Value="public sealed struct TooltipsData;" Maintainer="auto" />
+  <TypeSignature Language="C#" Value="public sealed struct TooltipsData;" Maintainer="John Luke" />
   <AssemblyInfo>
     <AssemblyName>gtk-sharp</AssemblyName>
-    <AssemblyPublicKey></AssemblyPublicKey>
+    <AssemblyPublicKey>
+    </AssemblyPublicKey>
     <AssemblyVersion>0.0.0.0</AssemblyVersion>
     <AssemblyCulture>neutral</AssemblyCulture>
     <Attributes />
   </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>
-    <remarks>To be added</remarks>
+    <summary>The data needed for a <see cref="T:Gtk.Tooltips" /></summary>
+    <remarks></remarks>
   </Docs>
   <Base>
     <BaseTypeName>System.ValueType</BaseTypeName>
@@ -26,8 +27,8 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
-        <remarks>To be added</remarks>
+        <summary>A <see cref="T:Gtk.TooltipsData" /> with default values.</summary>
+        <remarks></remarks>
       </Docs>
     </Member>
     <Member MemberName="tip_text">
@@ -38,8 +39,8 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
-        <remarks>To be added</remarks>
+        <summary>A string containing the tooltip message.</summary>
+        <remarks></remarks>
       </Docs>
     </Member>
     <Member MemberName="tip_private">
@@ -50,8 +51,8 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
-        <remarks>To be added</remarks>
+        <summary>A string that is not shown as the default tooltip.</summary>
+        <remarks>Instead, this message may be more informative and go towards forming a context-sensitive help system for your application. (FIXME: how to actually "switch on" private tips?)</remarks>
       </Docs>
     </Member>
     <Member MemberName="Get">
@@ -64,10 +65,10 @@
         <Parameter Name="widget" Type="Gtk.Widget" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
-        <param name="widget">To be added: an object of type 'Gtk.Widget'</param>
-        <returns>To be added: an object of type 'Gtk.TooltipsData'</returns>
-        <remarks>To be added</remarks>
+        <summary>Gets the <see cref="T:Gtk.TooltipsData" /> associated with <paramref name="widget" />.</summary>
+        <param name="widget">an object of type <see cref="T:Gtk.Widget" /></param>
+        <returns>an object of type <see cref="T:Gtk.TooltipsData" /></returns>
+        <remarks></remarks>
       </Docs>
     </Member>
     <Member MemberName="New">
@@ -80,10 +81,10 @@
         <Parameter Name="raw" Type="System.IntPtr" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
-        <param name="raw">To be added: an object of type 'IntPtr'</param>
-        <returns>To be added: an object of type 'Gtk.TooltipsData'</returns>
-        <remarks>To be added</remarks>
+        <summary>Creates a new TooltipsData object.</summary>
+        <param name="raw">an object of type <see cref="T:System.IntPtr" /></param>
+        <returns>an object of type <see cref="T:Gtk.TooltipsData" /></returns>
+        <remarks>This is not typically used directly by applications.</remarks>
       </Docs>
     </Member>
     <Member MemberName="widget">
@@ -92,12 +93,13 @@
       <ReturnValue>
         <ReturnType>Gtk.Widget</ReturnType>
       </ReturnValue>
-      <Parameters></Parameters>
+      <Parameters>
+      </Parameters>
       <Docs>
-        <summary>To be added</summary>
-        <param name="value">To be added: an object of type 'Gtk.Widget'</param>
-        <returns>To be added: an object of type 'Gtk.Widget'</returns>
-        <remarks>To be added</remarks>
+        <summary>The <see cref="T:Gtk.Widget" /> that this <see cref="T:Gtk.TooltipsData" /> is associated with.</summary>
+        <param name="value">an object of type <see cref="T:Gtk.Widget" /></param>
+        <returns>an object of type <see cref="T:Gtk.Widget" /></returns>
+        <remarks></remarks>
       </Docs>
     </Member>
     <Member MemberName="tooltips">
@@ -106,13 +108,14 @@
       <ReturnValue>
         <ReturnType>Gtk.Tooltips</ReturnType>
       </ReturnValue>
-      <Parameters></Parameters>
+      <Parameters>
+      </Parameters>
       <Docs>
         <summary>To be added</summary>
-        <param name="value">To be added: an object of type 'Gtk.Tooltips'</param>
-        <returns>To be added: an object of type 'Gtk.Tooltips'</returns>
-        <remarks>To be added</remarks>
+        <param name="value">an object of type <see cref="T:Gtk.Tooltips" /></param>
+        <returns>an object of type <see cref="T:Gtk.Tooltips" /></returns>
+        <remarks></remarks>
       </Docs>
     </Member>
   </Members>
-</Type>
\ No newline at end of file
+</Type>