From a2a35870364d925d1217e4973bbcff53fc3c880d Mon Sep 17 00:00:00 2001 From: Benjamin Otte Date: Sun, 2 Aug 2015 17:36:05 +0200 Subject: [PATCH] gmain: Document return value of GSourceFuncs.dispatch --- glib/gmain.h | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/glib/gmain.h b/glib/gmain.h index 603fdfc54..746edd756 100644 --- a/glib/gmain.h +++ b/glib/gmain.h @@ -101,7 +101,9 @@ typedef struct _GSourceCallbackFuncs GSourceCallbackFuncs; * function may be %NULL if the source was never connected to a callback * using g_source_set_callback(). The @dispatch function should call the * callback function with @user_data and whatever additional parameters - * are needed for this type of event source. + * are needed for this type of event source. The return value of the + * @dispatch function should be #G_SOURCE_REMOVE if the source should be + * removed or #G_SOURCE_CONTINUE to keep it. * @finalize: Called when the source is finalized. * * The `GSourceFuncs` struct contains a table of