]> Pileus Git - ~andy/gtk/commitdiff
docs: Add gtk-doc comment for GtkTreeRowReference
authorDavid King <amigadave@amigadave.com>
Thu, 22 Nov 2012 18:38:21 +0000 (18:38 +0000)
committerDavid King <amigadave@amigadave.com>
Mon, 26 Nov 2012 14:12:14 +0000 (14:12 +0000)
https://bugzilla.gnome.org/show_bug.cgi?id=93381

gtk/gtktreemodel.h

index ea81a21c47b13c23cc5a7969e5a046f9ba3cf8c9..7d082f1dea032bd192324d989ce1ef6bdd1331b0 100644 (file)
@@ -190,9 +190,12 @@ gboolean     gtk_tree_path_is_ancestor      (GtkTreePath       *path,
 gboolean     gtk_tree_path_is_descendant    (GtkTreePath       *path,
                                              GtkTreePath       *ancestor);
 
-/* Row reference (an object that tracks model changes so it refers to the same
- * row always; a path refers to a position, not a fixed row).  You almost always
- * want to call gtk_tree_row_reference_new.
+/**
+ * GtkTreeRowReference:
+ *
+ * A GtkTreeRowReference tracks model changes so that it always refers to the
+ * same row (a #GtkTreePath refers to a position, not a fixed row). Create a
+ * new GtkTreeRowReference with gtk_tree_row_reference_new().
  */
 
 GType                gtk_tree_row_reference_get_type (void) G_GNUC_CONST;