summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian Dröge <slomo@coaxion.net>2021-05-06 14:00:19 +0000
committerSebastian Dröge <slomo@coaxion.net>2021-05-06 14:00:19 +0000
commit730cc864efc8b2a1b66cae398c4b9cd374f93b5d (patch)
treecbd54bd1c9837d9c43fb047a0374dc2fd4aa81d5
parent7bfda46cc3f826861a4269cf5672060dfe85530d (diff)
parente010624309c408bacfe6bca575ec848aee04826f (diff)
downloadglib-730cc864efc8b2a1b66cae398c4b9cd374f93b5d.tar.gz
Merge branch 'jomccambridge-master-patch-47329' into 'master'
Update signal accumulator docs. Closes #2352 See merge request GNOME/glib!2058
-rw-r--r--gobject/gsignal.h7
1 files 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,