gmain: Document return value of GSourceFuncs.dispatch

This commit is contained in:
Benjamin Otte 2015-08-02 17:36:05 +02:00
parent 6b652b1a2e
commit a2a3587036

View File

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