[glib: 1/2] Update signal accumulator docs.




commit e010624309c408bacfe6bca575ec848aee04826f
Author: John McCambridge <jomccambridge gmail com>
Date:   Wed Apr 21 12:13:41 2021 +0000

    Update signal accumulator docs.
    
    Reflect that a FALSE returned from the accumulator will still emit signals in the RUN_CLEANUP state.
    Fixes #2352

 gobject/gsignal.h | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
---
diff --git a/gobject/gsignal.h b/gobject/gsignal.h
index 64aa9d6a8..b027f54c0 100644
--- a/gobject/gsignal.h
+++ b/gobject/gsignal.h
@@ -87,8 +87,11 @@ typedef gboolean (*GSignalEmissionHook) (GSignalInvocationHint *ihint,
  * value returned by the last callback.
  * 
  * Returns: The accumulator function returns whether the signal emission
- *  should be aborted. Returning %FALSE means to abort the
- *  current emission and %TRUE is returned for continuation.
+ *  should be aborted. Returning %TRUE will continue with
+ *  the signal emission. Returning %FALSE will abort the current emission.
+ *  Since 2.62, returning %FALSE will skip to the CLEANUP stage. In this case,
+ *  emission will occur as normal in the CLEANUP stage and the handler's
+ *  return value will be accumulated.
  */
 typedef gboolean (*GSignalAccumulator) (GSignalInvocationHint *ihint,
                                         GValue                *return_accu,


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