Tree Model documentation patch:



Hello,
        This is a short addition to the documentation which I found
useful once I found it.  Also there is another bug I'd like to apply,
but I can't find it in the code anywhere:
In the doc for gtk_tree_model_get_iter_root() macro:
        A alternate name for gtk_tree_model_get_iter_root()
should read:
        An alternate name for gtk_tree_model_get_iter_first()
         ^                                            ^^^^^

        And is the correct way to submit such patches?  If not what
procedure should I follow?

        Regards,
        nash
-- 
Brett Nash <brettn cse unsw edu au>
This signature intentionally not included.
Index: gtktreemodel.c
===================================================================
RCS file: /cvs/gnome/gtk+/gtk/gtktreemodel.c,v
retrieving revision 1.90
diff -u -B -r1.90 gtktreemodel.c
--- gtktreemodel.c	2002/07/05 17:25:16	1.90
+++ gtktreemodel.c	2002/07/26 06:21:11
@@ -853,11 +853,14 @@
  * gtk_tree_model_iter_children:
  * @tree_model: A #GtkTreeModel.
  * @iter: The new #GtkTreeIter to be set to the child.
- * @parent: The #GtkTreeIter.
+ * @parent: The #GtkTreeIter, or %NULL.
  *
  * Sets @iter to point to the first child of @parent.  If @parent has no children,
  * %FALSE is returned and @iter is set to be invalid.  @parent will remain a valid
  * node after this function has been called.
+ *
+ * If @parent is %NULL returns the first node, equivelent to
+ * <literal>gtk_tree_model_get_iter_first(tree_model,iter);</literal>
  *
  * Return value: %TRUE, if @child has been set to the first child.
  **/


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]