After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 773355 - Incorrect documentation about stopping a signal emission from a hook
Incorrect documentation about stopping a signal emission from a hook
Status: RESOLVED FIXED
Product: glib
Classification: Platform
Component: docs
2.50.x
Other Linux
: Normal normal
: ---
Assigned To: gtkdev
gtkdev
Depends on:
Blocks:
 
 
Reported: 2016-10-22 14:11 UTC by Colomban Wendling
Modified: 2017-10-05 14:26 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
Fix documentation about stopping signal emission from inside a hook (1.28 KB, patch)
2016-10-22 14:11 UTC, Colomban Wendling 		committed Details | Review

Description Colomban Wendling 2016-10-22 14:11:13 UTC 
Created attachment 338268 [details] [review]
Fix documentation about stopping signal emission from inside a hook

The "Signal emission" documentation on GObject is wrong regarding stopping an emission from inside an emission hook.  It explicitly states it is allowed, yet it isn't (g_signal_stop_emission() and _by_name() explicitly check against it) and seems to never have been.

Attached patch fixes the documentation on that regard.
Comment 1 Philip Withnall 2017-10-05 14:25:35 UTC 
Review of attachment 338268 [details] [review]:

++
Comment 2 Philip Withnall 2017-10-05 14:26:37 UTC 
Attachment 338268 [details] pushed as b090a07 - Fix documentation about stopping signal emission from inside a hook