[PATCH] Minor typo in Gtk::TreeView documentation



In the reference documentation for Gtk::TreeView::SlotForeach***, the
callbacks are defined to return a bool, however the examples in the
documentation says "void".

http://gtkmm.org/docs/gtkmm-2.4/docs/reference/html/classGtk_1_1TreeModel.html#9db469cffdaa5e2d38b6a8427acd12c4

A patch against trunk is attached.

With kind regards,

Mikael Olenfalk
Index: gtk/src/treemodel.hg
===================================================================
--- gtk/src/treemodel.hg	(revision 983)
+++ gtk/src/treemodel.hg	(working copy)
@@ -135,7 +135,7 @@
   _IGNORE(gtk_tree_model_foreach)
 
   /** For example,
-   * void on_foreach(const Gtk::TreeModel::iterator& iter);
+   * bool on_foreach(const Gtk::TreeModel::iterator& iter);
    *
    * If the callback function returns true, then the tree ceases to be walked, and foreach() returns.
    */
@@ -149,7 +149,7 @@
   void foreach_iter(const SlotForeachIter& slot);
 
   /** For example,
-   * void on_foreach(const Gtk::TreeModel::Path& path);
+   * bool on_foreach(const Gtk::TreeModel::Path& path);
    *
    * If the callback function returns true, then the tree ceases to be walked, and foreach() returns.
    */
@@ -163,7 +163,7 @@
   void foreach_path(const SlotForeachPath& slot);
 
   /** For example,
-   * void on_foreach(const Gtk::TreeModel::Path& path, const Gtk::TreeModel::iterator& iter);
+   * bool on_foreach(const Gtk::TreeModel::Path& path, const Gtk::TreeModel::iterator& iter);
    *
    * If the callback function returns true, then the tree ceases to be walked, and foreach() returns.
    */


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