liststore: Make gtk_list_store_reorder() introspectable
authorMartin Pitt <martinpitt@gnome.org>
Tue, 12 Jun 2012 13:41:03 +0000 (15:41 +0200)
committerMartin Pitt <martinpitt@gnome.org>
Tue, 12 Jun 2012 15:18:55 +0000 (17:18 +0200)
Mark the new_order argument as zero-terminated array, even though it does not
need to be zero terminated (it has an implicit length not given by a constant
or another method argument). It does not hurt if bindings append an extra zero
to the array as long as it has enough elements, and this makes the method
introspectable.

https://bugzilla.gnome.org/show_bug.cgi?id=677941

gtk/gtkliststore.c

index 2d99d5f36c7e25132d2680d6bdb97f70d98230b8..ee07b878117271dc3b455cc3a90272f7f9b13a04 100644 (file)
@@ -1691,11 +1691,12 @@ gtk_list_store_reorder_func (GSequenceIter *a,
 }
   
 /**
- * gtk_list_store_reorder: (skip)
+ * gtk_list_store_reorder:
  * @store: A #GtkListStore.
- * @new_order: (array): an array of integers mapping the new position of each child
- *      to its old position before the re-ordering,
- *      i.e. @new_order<literal>[newpos] = oldpos</literal>.
+ * @new_order: (array zero-terminated=1): an array of integers mapping the new
+ *      position of each child to its old position before the re-ordering,
+ *      i.e. @new_order<literal>[newpos] = oldpos</literal>. It must have
+ *      exactly as many items as the list store's length.
  *
  * Reorders @store to follow the order indicated by @new_order. Note that
  * this function only works with unsorted stores.