[clutter] pan-action, zoom-action: Fix documentation for signals



commit 90a2401299418a5e6b4d0ceb6692a6c758414cdf
Author: Jasper St. Pierre <jstpierre mecheye net>
Date:   Sun Nov 25 23:25:20 2012 -0500

    pan-action, zoom-action: Fix documentation for signals
    
    The documentation said that you should return TRUE to mark
    that the action was handled, but the code did the reverse.
    Change the documentation to reflect what all the other gestures
    do.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=689061

 clutter/clutter-pan-action.c  |    4 ++--
 clutter/clutter-zoom-action.c |    4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)
---
diff --git a/clutter/clutter-pan-action.c b/clutter/clutter-pan-action.c
index 8aa7281..489c867 100644
--- a/clutter/clutter-pan-action.c
+++ b/clutter/clutter-pan-action.c
@@ -522,8 +522,8 @@ clutter_pan_action_class_init (ClutterPanActionClass *klass)
    * interpolation phase of the pan, after the drag has ended and
    * the :interpolate property was set to %TRUE.
    *
-   * Return value: TRUE if the pan action has been handled by one of
-   * the listener or %FALSE to continue the emission.
+   * Return value: %TRUE if the pan should continue, and %FALSE if
+   *   the pan should be cancelled.
    *
    * Since: 1.12
    */
diff --git a/clutter/clutter-zoom-action.c b/clutter/clutter-zoom-action.c
index 821a86b..f62c96b 100644
--- a/clutter/clutter-zoom-action.c
+++ b/clutter/clutter-zoom-action.c
@@ -382,8 +382,8 @@ clutter_zoom_action_class_init (ClutterZoomActionClass *klass)
    * this signal and call g_signal_stop_emission_by_name() from within
    * your callback.
    *
-   * Return value: %TRUE if the zoom action has been handled by one of
-   * the listener or %FALSE to continue the emission.
+   * Return value: %TRUE if the zoom should continue, and %FALSE if
+   *   the zoom should be cancelled.
    *
    * Since: 1.12
    */



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