summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilip Withnall <withnall@endlessm.com>2019-09-06 10:49:39 +0100
committerPhilip Withnall <withnall@endlessm.com>2019-09-06 10:49:39 +0100
commitf02c6eb5145304f0a73370993b1e95da92758f6e (patch)
treeaf0225718bea72bc63f7c96b1525248daa81f95c
parentf7eed7eabd7afcd20ed46df234e40ef574c7b253 (diff)
downloadglib-f02c6eb5145304f0a73370993b1e95da92758f6e.tar.gz
giochannel: Clarify type of GSource callback in documentation
This should clarify questions like https://stackoverflow.com/q/57807738/2931197. Signed-off-by: Philip Withnall <withnall@endlessm.com>
-rw-r--r--glib/giochannel.c3
1 files changed, 3 insertions, 0 deletions
diff --git a/glib/giochannel.c b/glib/giochannel.c
index 1956e9dc6..ed8546331 100644
--- a/glib/giochannel.c
+++ b/glib/giochannel.c
@@ -596,6 +596,9 @@ g_io_channel_purge (GIOChannel *channel)
* given @channel. For example, if condition is #G_IO_IN, the source will
* be dispatched when there's data available for reading.
*
+ * The callback function invoked by the #GSource should be added with
+ * g_source_set_callback(), but it has type #GIOFunc (not #GSourceFunc).
+ *
* g_io_add_watch() is a simpler interface to this same functionality, for
* the case where you want to add the source to the default main loop context
* at the default priority.