summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid King <amigadave@amigadave.com>2012-11-22 18:38:21 +0000
committerDavid King <amigadave@amigadave.com>2012-11-26 14:13:22 +0000
commit1837787ce60e714a5a45ca1053f32c263c803fbe (patch)
treec7f5bee5444e73789be84416dd156ad7a65356c7
parent94fecf591a483cb227ce8ad9a423170f9cd4d0f3 (diff)
downloadgtk+-1837787ce60e714a5a45ca1053f32c263c803fbe.tar.gz
docs: Add gtk-doc comment for GtkTreeRowReference
https://bugzilla.gnome.org/show_bug.cgi?id=93381
-rw-r--r--gtk/gtktreemodel.h9
1 files changed, 6 insertions, 3 deletions
diff --git a/gtk/gtktreemodel.h b/gtk/gtktreemodel.h
index ea81a21c47..7d082f1dea 100644
--- a/gtk/gtktreemodel.h
+++ b/gtk/gtktreemodel.h
@@ -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;