[gtk+] docs: Improve GtkTreeModel iteration pattern



commit c627b221264ff93f5bb4e172fb875a57ec7e5959
Author: David King <amigadave amigadave com>
Date:   Thu Nov 22 17:38:41 2012 +0000

    docs: Improve GtkTreeModel iteration pattern
    
    Iterating over the model in this way means that use of continue is less
    error-prone, as the increment is part of the loop construct.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=548793

 gtk/gtktreemodel.c |   11 +++++------
 1 files changed, 5 insertions(+), 6 deletions(-)
---
diff --git a/gtk/gtktreemodel.c b/gtk/gtktreemodel.c
index a2abead..31d8843 100644
--- a/gtk/gtktreemodel.c
+++ b/gtk/gtktreemodel.c
@@ -168,12 +168,12 @@
  * /&ast; Fill the list store with data &ast;/
  * populate_model (list_store);
  *
- * /&ast; Get the first iter in the list &ast;/
- * valid = gtk_tree_model_get_iter_first (list_store, &amp;iter);
- *
- * while (valid)
+ * /&ast; Get the first iter in the list, check it is valid and walk
+ *  &ast; through the list, reading each row. &ast;/
+ * for (valid = gtk_tree_model_get_iter_first (list_store, &amp;iter);
+ *      valid;
+ *      valid = gtk_tree_model_iter_next (list_store, &amp;iter))
  *  {
- *    /&ast; Walk through the list, reading each row &ast;/
  *    gchar *str_data;
  *    gint   int_data;
  *
@@ -190,7 +190,6 @@
  *    g_free (str_data);
  *
  *    row_count++;
- *    valid = gtk_tree_model_iter_next (list_store, &amp;iter);
  *  }
  * </programlisting>
  * </example>



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