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

gmain: Mark context as nullable in docs where appropriate

Browse Source 
GMainContext can be NULL in various functions, but we don't mark it as such.
This commit is contained in:
Marco Trevisan (Treviño) 2023-01-25 20:15:56 +01:00
parent 62ee931fce
commit 3b2c7aba99
1 changed files with 20 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
glib/gmain.c
View File

@ -2538,7 +2538,8 @@ g_main_context_find_source_by_funcs_user_data (GMainContext *context,
/** /**
* g_main_context_find_source_by_user_data: * g_main_context_find_source_by_user_data:
* @context: a #GMainContext * @context: (nullable): a #GMainContext (if %NULL, the global-default
* main context will be used)
* @user_data: the user_data for the callback. * @user_data: the user_data for the callback.
* *
* Finds a source with the given user data for the callback. If * Finds a source with the given user data for the callback. If
@ -3498,7 +3499,8 @@ g_main_dispatch (GMainContext *context)
/** /**
* g_main_context_acquire: * g_main_context_acquire:
* @context: a #GMainContext * @context: (nullable): a #GMainContext (if %NULL, the global-default
* main context will be used)
* *
* Tries to become the owner of the specified context. * Tries to become the owner of the specified context.
* If some other thread is the owner of the context, * If some other thread is the owner of the context,
@ -3549,7 +3551,8 @@ g_main_context_acquire (GMainContext *context)
/** /**
* g_main_context_release: * g_main_context_release:
* @context: a #GMainContext * @context: (nullable): a #GMainContext (if %NULL, the global-default
* main context will be used)
* *
* Releases ownership of a context previously acquired by this thread * Releases ownership of a context previously acquired by this thread
* with g_main_context_acquire(). If the context was acquired multiple * with g_main_context_acquire(). If the context was acquired multiple
@ -3645,7 +3648,8 @@ g_main_context_wait_internal (GMainContext *context,
/** /**
* g_main_context_wait: * g_main_context_wait:
* @context: a #GMainContext * @context: (nullable): a #GMainContext (if %NULL, the global-default
* main context will be used)
* @cond: a condition variable * @cond: a condition variable
* @mutex: a mutex, currently held * @mutex: a mutex, currently held
* *
@ -3684,7 +3688,8 @@ g_main_context_wait (GMainContext *context,
/** /**
* g_main_context_prepare: * g_main_context_prepare:
* @context: a #GMainContext * @context: (nullable): a #GMainContext (if %NULL, the global-default
* main context will be used)
* @priority: (out) (optional): location to store priority of highest priority * @priority: (out) (optional): location to store priority of highest priority
* source already ready. * source already ready.
* *
@ -4695,7 +4700,8 @@ g_main_context_add_poll_unlocked (GMainContext *context,
/** /**
* g_main_context_remove_poll: * g_main_context_remove_poll:
* @context:a #GMainContext * @context: (nullable): a #GMainContext (if %NULL, the global-default
* main context will be used)
* @fd: a #GPollFD descriptor previously added with g_main_context_add_poll() * @fd: a #GPollFD descriptor previously added with g_main_context_add_poll()
* *
* Removes file descriptor from the set of file descriptors to be * Removes file descriptor from the set of file descriptors to be
@ -4817,7 +4823,8 @@ g_source_get_time (GSource *source)
/** /**
* g_main_context_set_poll_func: * g_main_context_set_poll_func:
* @context: a #GMainContext * @context: (nullable): a #GMainContext (if %NULL, the global-default
* main context will be used)
* @func: the function to call to poll all file descriptors * @func: the function to call to poll all file descriptors
* *
* Sets the function to use to handle polling of file descriptors. It * Sets the function to use to handle polling of file descriptors. It
@ -4849,7 +4856,8 @@ g_main_context_set_poll_func (GMainContext *context,
/** /**
* g_main_context_get_poll_func: * g_main_context_get_poll_func:
* @context: a #GMainContext * @context: (nullable): a #GMainContext (if %NULL, the global-default
* main context will be used)
* *
* Gets the poll function set by g_main_context_set_poll_func(). * Gets the poll function set by g_main_context_set_poll_func().
* *
@ -4874,7 +4882,8 @@ g_main_context_get_poll_func (GMainContext *context)
/** /**
* g_main_context_wakeup: * g_main_context_wakeup:
* @context: a #GMainContext * @context: (nullable): a #GMainContext (if %NULL, the global-default
* main context will be used)
* *
* If @context is currently blocking in g_main_context_iteration() * If @context is currently blocking in g_main_context_iteration()
* waiting for a source to become ready, cause it to stop blocking * waiting for a source to become ready, cause it to stop blocking
@ -4920,7 +4929,8 @@ g_main_context_wakeup (GMainContext *context)
/** /**
* g_main_context_is_owner: * g_main_context_is_owner:
* @context: a #GMainContext * @context: (nullable): a #GMainContext (if %NULL, the global-default
* main context will be used)
* *
* Determines whether this thread holds the (recursive) * Determines whether this thread holds the (recursive)
* ownership of this #GMainContext. This is useful to * ownership of this #GMainContext. This is useful to