luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-10 03:16:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

gmain: Clarify documentation of g_source_remove()

Browse Source 
To try and prevent a repeat of
https://stackoverflow.com/q/47569812/2931197.

Signed-off-by: Philip Withnall <withnall@endlessm.com>
Reviewed-by: nobody
This commit is contained in:
Philip Withnall 2017-12-01 10:24:09 +00:00
parent 36f7440bb7
commit 532f1edd88
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
glib/gmain.c
View File

@ -2322,17 +2322,15 @@ g_main_context_find_source_by_user_data (GMainContext *context,
* g_source_remove:
* @tag: the ID of the source to remove.
*
* Removes the source with the given id from the default main context.
* Removes the source with the given ID from the default main context. You must
* use g_source_destroy() for sources added to a non-default main context.
*
* The id of a #GSource is given by g_source_get_id(), or will be
* The ID of a #GSource is given by g_source_get_id(), or will be
* returned by the functions g_source_attach(), g_idle_add(),
* g_idle_add_full(), g_timeout_add(), g_timeout_add_full(),
* g_child_watch_add(), g_child_watch_add_full(), g_io_add_watch(), and
* g_io_add_watch_full().
*
* See also g_source_destroy(). You must use g_source_destroy() for sources
* added to a non-default main context.
*
* It is a programmer error to attempt to remove a non-existent source.
*
* More specifically: source IDs can be reissued after a source has been