perl-Gtk2 r2100 - in trunk: . xs

[tsch svn gnome org]

Author: tsch
Date: Tue Dec 30 14:47:41 2008
New Revision: 2100
URL: http://svn.gnome.org/viewvc/perl-Gtk2?rev=2100&view=rev

Log:
Document the signature of the callback used by Gtk2::TreeModel::foreach.  Patch
by Kevin Ryde.


Modified:
   trunk/ChangeLog
   trunk/xs/GtkTreeModel.xs

Modified: trunk/xs/GtkTreeModel.xs
==============================================================================
--- trunk/xs/GtkTreeModel.xs	(original)
+++ trunk/xs/GtkTreeModel.xs	Tue Dec 30 14:47:41 2008
@@ -1317,8 +1317,11 @@
 ## void gtk_tree_model_foreach (GtkTreeModel *model, GtkTreeModelForeachFunc func, gpointer user_data)
 =for apidoc
 =for arg func (subroutine)
-Call I<$func> on each row in I<$model>.  I<$func> gets the tree path and iter
-of the current row; if I<$func> returns true, the tree ceases to be walked,
+Call I<$func> on each row in I<$model> as
+
+    bool = &$func ($model, $path, $iter, $user_data)
+
+If I<$func> returns true, the tree ceases to be walked,
 and C<< $treemodel->foreach >> returns.
 =cut
 void