From 3e18029f5f34073aeeed79ca24ae10614f3f29df Mon Sep 17 00:00:00 2001
From: Mike Kestner <mkestner@gmail.com>
Date: Wed, 5 Nov 2003 23:56:57 +0000
Subject: [PATCH] 2003-11-05  Mike Kestner  <mkestner@ximian.com>

	* en/Gtk/ITreeNode.xml : documented
	* en/Gtk/TreeNodeAddedHandler.xml : documented
	* en/Gtk/TreeNodeRemovedHandler.xml : documented

svn path=/trunk/gtk-sharp/; revision=19654
---
 doc/ChangeLog                         |  6 +++
 doc/en/Gtk/ITreeNode.xml              | 62 +++++++++++++++++----------
 doc/en/Gtk/TreeNodeAddedHandler.xml   |  8 ++--
 doc/en/Gtk/TreeNodeRemovedHandler.xml | 10 +++--
 4 files changed, 57 insertions(+), 29 deletions(-)

diff --git a/doc/ChangeLog b/doc/ChangeLog
index 43face4fa..b4bf3e0d9 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,9 @@
+2003-11-05  Mike Kestner  <mkestner@ximian.com>
+
+	* en/Gtk/ITreeNode.xml : documented
+	* en/Gtk/TreeNodeAddedHandler.xml : documented
+	* en/Gtk/TreeNodeRemovedHandler.xml : documented
+
 2003-11-05  Mike Kestner  <mkestner@ximian.com>
 
 	* en/Gtk/TreeNodeAttribute.xml : documented
diff --git a/doc/en/Gtk/ITreeNode.xml b/doc/en/Gtk/ITreeNode.xml
index 6b240a160..5871ef5fc 100644
--- a/doc/en/Gtk/ITreeNode.xml
+++ b/doc/en/Gtk/ITreeNode.xml
@@ -1,5 +1,5 @@
 <Type Name="ITreeNode" FullName="Gtk.ITreeNode">
-  <TypeSignature Language="C#" Value="public abstract interface ITreeNode" Maintainer="auto" />
+  <TypeSignature Language="C#" Value="public abstract interface ITreeNode" Maintainer="Mike Kestner" />
   <AssemblyInfo>
     <AssemblyName>gtk-sharp</AssemblyName>
     <AssemblyPublicKey></AssemblyPublicKey>
@@ -7,10 +7,14 @@
     <AssemblyCulture>neutral</AssemblyCulture>
     <Attributes />
   </AssemblyInfo>
-  <ThreadSafetyStatement />
+  <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>Tree Node navigation and update notification interface</summary>
+    <remarks>
+      Implement this interface for types which expose tree node information.
+      Types which implement this interface can be used to instantiate a
+      <see cref="T:Gtk.NodeStore" /> for a <see cref="T:Gtk.TreeView" />
+    </remarks>
   </Docs>
   <Base />
   <Interfaces />
@@ -30,10 +34,14 @@
         <Parameter Name="o" Type="System.Object" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>IndexOf method</summary>
         <param name="o">a <see cref="T:System.Object" /></param>
         <returns>a <see cref="T:System.Int32" /></returns>
-        <remarks>To be added</remarks>
+        <remarks>
+          Returns the position of the specified child object in the
+          list of children. If the child is not found, the returned
+          value should be less than 0, typically -1.
+	</remarks>
       </Docs>
     </Member>
     <Member MemberName="ID">
@@ -44,22 +52,29 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>ID property</summary>
         <returns>a <see cref="T:System.Int32" /></returns>
-        <remarks>To be added</remarks>
+        <remarks>
+	  Read-only. Represents a unique identifier for the object as a positive integer.
+	  This value is used by the <see cref="T:Gtk.NodeStore" /> as a hash value and
+	  must uniquely identify the object.
+	</remarks>
       </Docs>
     </Member>
     <Member MemberName="Parent">
-      <MemberSignature Language="C#" Value="public virtual Gtk.ITreeNode Parent { set; get; };" />
+      <MemberSignature Language="C#" Value="public virtual Gtk.ITreeNode Parent { get; };" />
       <MemberType>Property</MemberType>
       <ReturnValue>
         <ReturnType>Gtk.ITreeNode</ReturnType>
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>Parent property</summary>
         <returns>a <see cref="T:Gtk.ITreeNode" /></returns>
-        <remarks>To be added</remarks>
+        <remarks>
+          Read-only, The parent <see cref="T:Gtk.ITreeNode" /> for this <see cref="T:Gtk.ITreeNode" />
+	  or <see langword="null" /> if the node is a root <see cref="T:Gtk.ITreeNode" />. 
+	</remarks>
       </Docs>
     </Member>
     <Member MemberName="ChildCount">
@@ -70,9 +85,9 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>ChildCount property</summary>
         <returns>a <see cref="T:System.Int32" /></returns>
-        <remarks>To be added</remarks>
+        <remarks>Read-only.  Indicates the number of children of this <see cref="T:Gtk.ITreeNode" /></remarks>
       </Docs>
     </Member>
     <Member MemberName="Item">
@@ -85,10 +100,13 @@
         <Parameter Name="index" Type="System.Int32" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>Child indexer</summary>
         <param name="index">a <see cref="T:System.Int32" /></param>
         <returns>a <see cref="T:Gtk.ITreeNode" /></returns>
-        <remarks>To be added</remarks>
+        <remarks>
+          Returns the child at position <paramref name="index" /> in the list of children 
+          of this <see cref="T:Gtk.ITreeNode" />
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="Changed">
@@ -99,8 +117,8 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
-        <remarks>To be added</remarks>
+        <summary>Changed event</summary>
+        <remarks>Emited when the tree-related contents of the node have changed.</remarks>
       </Docs>
     </Member>
     <Member MemberName="ChildAdded">
@@ -111,8 +129,8 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
-        <remarks>To be added</remarks>
+        <summary>ChildAdded event</summary>
+        <remarks>Emited when a child <see cref="T:Gtk.ITreeNode" /> is added to the <see cref="T:Gtk.ITreeNode" />.</remarks>
       </Docs>
     </Member>
     <Member MemberName="ChildRemoved">
@@ -123,9 +141,9 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
-        <remarks>To be added</remarks>
+        <summary>ChildRemoved event</summary>
+        <remarks>Emited when a child <see cref="T:Gtk.ITreeNode" /> is removed from the <see cref="T:Gtk.ITreeNode" />.</remarks>
       </Docs>
     </Member>
   </Members>
-</Type>
\ No newline at end of file
+</Type>
diff --git a/doc/en/Gtk/TreeNodeAddedHandler.xml b/doc/en/Gtk/TreeNodeAddedHandler.xml
index f3cec0130..0eda8d0ea 100644
--- a/doc/en/Gtk/TreeNodeAddedHandler.xml
+++ b/doc/en/Gtk/TreeNodeAddedHandler.xml
@@ -1,5 +1,5 @@
 <Type Name="TreeNodeAddedHandler" FullName="Gtk.TreeNodeAddedHandler">
-  <TypeSignature Language="C#" Value="public sealed delegate void TreeNodeAddedHandler (object o, Gtk.ITreeNode child);" Maintainer="auto" />
+  <TypeSignature Language="C#" Value="public sealed delegate void TreeNodeAddedHandler (object o, Gtk.ITreeNode child);" Maintainer="Mike Kestner" />
   <AssemblyInfo>
     <AssemblyName>gtk-sharp</AssemblyName>
     <AssemblyPublicKey></AssemblyPublicKey>
@@ -9,8 +9,8 @@
   </AssemblyInfo>
   <ThreadSafetyStatement />
   <Docs>
-    <summary>To be added</summary>
-    <remarks>To be added</remarks>
+    <summary>TreeNodeAddedHandler delegate</summary>
+    <remarks>Event handler for notification of the addition of a <paramref name="child" /> to  node <paramref name="o" />.</remarks>
   </Docs>
   <Base>
     <BaseTypeName>System.Delegate</BaseTypeName>
@@ -32,4 +32,4 @@
     <Parameter Name="o" Type="System.Object" />
     <Parameter Name="child" Type="Gtk.ITreeNode" />
   </Parameters>
-</Type>
\ No newline at end of file
+</Type>
diff --git a/doc/en/Gtk/TreeNodeRemovedHandler.xml b/doc/en/Gtk/TreeNodeRemovedHandler.xml
index efc0d7804..37683ded7 100644
--- a/doc/en/Gtk/TreeNodeRemovedHandler.xml
+++ b/doc/en/Gtk/TreeNodeRemovedHandler.xml
@@ -1,5 +1,5 @@
 <Type Name="TreeNodeRemovedHandler" FullName="Gtk.TreeNodeRemovedHandler">
-  <TypeSignature Language="C#" Value="public sealed delegate void TreeNodeRemovedHandler (object o, int old_position);" Maintainer="auto" />
+  <TypeSignature Language="C#" Value="public sealed delegate void TreeNodeRemovedHandler (object o, int old_position);" Maintainer="Mike Kestner" />
   <AssemblyInfo>
     <AssemblyName>gtk-sharp</AssemblyName>
     <AssemblyPublicKey></AssemblyPublicKey>
@@ -9,8 +9,12 @@
   </AssemblyInfo>
   <ThreadSafetyStatement />
   <Docs>
-    <summary>To be added</summary>
-    <remarks>To be added</remarks>
+    <summary>TreeNodeRemovedHandler delegate</summary>
+    <remarks>
+      Event handler for notification of the removal of a child node.  The node is already
+      removed when the event is raised, so <paramref name="old_position" /> points to the
+      former position of the removed node in the child list of <paramref name="o" />.
+    </remarks>
   </Docs>
   <Base>
     <BaseTypeName>System.Delegate</BaseTypeName>