luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-06-11 07:10:09 +02:00
Code Issues Packages Projects Releases Wiki Activity

gmain: Mark several GSourceFuncs members as nullable

Browse Source 
Closes: https://gitlab.gnome.org/GNOME/glib/-/issues/3686
This commit is contained in:
BZZZZ 2025-05-14 11:30:22 +00:00 committed by Philip Withnall
parent 997c41b648
commit 4b938fc34b
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
glib/gmain.h
View File

@ -100,8 +100,8 @@ typedef struct _GSourceCallbackFuncs GSourceCallbackFuncs;
/** /**
* GSourceFuncs: * GSourceFuncs:
* @prepare: Called before all the file descriptors are polled. If the * @prepare: (nullable): Called before all the file descriptors are polled. If
* source can determine that it is ready here (without waiting for the * the source can determine that it is ready here (without waiting for the
* results of the poll() call) it should return %TRUE. It can also return * results of the poll() call) it should return %TRUE. It can also return
* a @timeout_ value which should be the maximum timeout (in milliseconds) * a @timeout_ value which should be the maximum timeout (in milliseconds)
* which should be passed to the poll() call. The actual timeout used will * which should be passed to the poll() call. The actual timeout used will
@ -111,9 +111,9 @@ typedef struct _GSourceCallbackFuncs GSourceCallbackFuncs;
* %FALSE with a timeout of -1. If @prepare returns a * %FALSE with a timeout of -1. If @prepare returns a
* timeout and the source also has a ready time set, then the * timeout and the source also has a ready time set, then the
* lower of the two will be used. * lower of the two will be used.
* @check: Called after all the file descriptors are polled. The source * @check: (nullable): Called after all the file descriptors are polled. The
* should return %TRUE if it is ready to be dispatched. Note that some * source should return %TRUE if it is ready to be dispatched. Note that
* time may have passed since the previous prepare function was called, * some time may have passed since the previous prepare function was called,
* so the source should be checked again here. Since 2.36 this may * so the source should be checked again here. Since 2.36 this may
* be %NULL, in which case the effect is as if the function always returns * be %NULL, in which case the effect is as if the function always returns
* %FALSE. * %FALSE.
@ -127,11 +127,12 @@ typedef struct _GSourceCallbackFuncs GSourceCallbackFuncs;
* The return value of the @dispatch function should be * The return value of the @dispatch function should be
* [const@GLib.SOURCE_REMOVE] if the source should be removed or * [const@GLib.SOURCE_REMOVE] if the source should be removed or
* [const@GLib.SOURCE_CONTINUE] to keep it. * [const@GLib.SOURCE_CONTINUE] to keep it.
* @finalize: Called when the source is finalized. At this point, the source * @finalize: (nullable): Called when the source is finalized. At this point,
* will have been destroyed, had its callback cleared, and have been removed * the source will have been destroyed, had its callback cleared, and have
* from its [struct@GLib.MainContext], but it will still have its final * been removed from its [struct@GLib.MainContext], but it will still have
* reference count, so methods can be called on it from within this * its final reference count, so methods can be called on it from within
* function. * this function. This may be %NULL, in which case the effect is as if the
* function does nothing and returns.
* *
* The `GSourceFuncs` struct contains a table of * The `GSourceFuncs` struct contains a table of
* functions used to handle event sources in a generic manner. * functions used to handle event sources in a generic manner.