Update signal accumulator docs.

Reflect that a FALSE returned from the accumulator will still emit signals in the RUN_CLEANUP state.
Fixes #2352
This commit is contained in:
John McCambridge 2021-04-21 12:13:41 +00:00
parent 80a938a205
commit e010624309

View File

@ -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,