2004-08-19 Shane Landrum <epicene@pobox.com>

Docs for tree-related classes:
	* en/Gtk/TreeView.xml
	* en/Gtk/TreeSelection.xml
	* en/Gtk/TreeSelectionForeachFunc.xml: Added docs for tree operations.
	* en/Gtk/RowsReorderedArgs.xml: Event data for list/tree datamodels.
	* en/Gtk/SelectCursorRowArgs.xml: Event data for TreeView event.
	* en/Gtk/TreeSelection.xml: Cleanup of extraneous TBA.

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

doc/ChangeLog

@@ -1,3 +1,13 @@
+2004-08-19  Shane Landrum <epicene@pobox.com>
+
+	Docs for tree-related classes:
+	* en/Gtk/TreeView.xml
+	* en/Gtk/TreeSelection.xml
+	* en/Gtk/TreeSelectionForeachFunc.xml: Added docs for tree operations.
+	* en/Gtk/RowsReorderedArgs.xml: Event data for list/tree datamodels.
+	* en/Gtk/SelectCursorRowArgs.xml: Event data for TreeView event.
+	* en/Gtk/TreeSelection.xml: Cleanup of extraneous TBA.
+
 2004-08-19  Shane Landrum <epicene@pobox.com>
 
 	* en/Gtk/RowHasChildToggledArgs.xml

doc/en/Gtk/RowsReorderedArgs.xml

@@ -58,9 +58,9 @@
         <ReturnType>System.Int32</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added</summary>
+        <summary>The new order of the rows.</summary>
-        <returns>To be added: an object of type 'int'</returns>
+        <returns>A <see cref="T:System.Int32" /></returns>
-        <remarks>To be added</remarks>
+        <remarks>FIXME: shouldn't this be an array?</remarks>
       </Docs>
     </Member>
     <Member MemberName="Iter">
@@ -70,9 +70,9 @@
         <ReturnType>Gtk.TreeIter</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added</summary>
+        <summary>Gets a pointer to the <see cref="T:Gtk.TreeNode"/> whose rows have been reordered.</summary>
-        <returns>To be added: an object of type 'Gtk.TreeIter'</returns>
+        <returns>A <see cref="Gtk.TreeIter"/></returns>
-        <remarks>To be added</remarks>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName="Path">
@@ -82,10 +82,10 @@
         <ReturnType>Gtk.TreePath</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added</summary>
+        <summary>A path for the <see cref="T:Gtk.TreeNode"/> whose rows have been reordered.</summary>
-        <returns>To be added: an object of type 'Gtk.TreePath'</returns>
+        <returns>A <see cref="Gtk.TreePath"/></returns>
-        <remarks>To be added</remarks>
+        <remarks />
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>

doc/en/Gtk/SelectCursorRowArgs.xml

@@ -39,10 +39,10 @@
         <ReturnType>System.Boolean</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added</summary>
+        <summary>Whether or not to start editing the specified row.</summary>
-        <returns>To be added: an object of type 'bool'</returns>
+        <returns>A <see cref="T:System.Boolean"/>, true if editing should start.</returns>
-        <remarks>To be added</remarks>
+        <remarks />
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>

doc/en/Gtk/TreeSelection.xml

@@ -524,8 +524,8 @@ class TreeSelectionSample
       <Docs>
         <summary>Protected constructor.</summary>
         <returns>a <see cref="T:Gtk.TreeSelection" /></returns>
-        <remarks>To be added</remarks>
+        <remarks />
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>

doc/en/Gtk/TreeSelectionForeachFunc.xml

@@ -7,8 +7,10 @@
   </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>A delegate class for functions that can be run on every element
-    <remarks>To be added</remarks>
+    of a <see cref="T:Gtk.TreeSelection"/>.</summary>
+    <remarks>See <see cref="M:Gtk.TreeSelection.SelectedForeach"/> for how to
+    invoke a delegate of this type.</remarks>
   </Docs>
   <Base>
     <BaseTypeName>System.Delegate</BaseTypeName>
@@ -31,4 +33,4 @@
   <ReturnValue>
     <ReturnType>System.Void</ReturnType>
   </ReturnValue>
-</Type>
+</Type>

doc/en/Gtk/TreeView.xml

@@ -943,7 +943,7 @@ public class TreeViewDemo {
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>Fired when the row the cursor is on is selected.</summary>
         <remarks />
       </Docs>
     </Member>
@@ -1739,4 +1739,4 @@ tree_view.AppendColumn ("title", text, "text", 0);
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>