luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-03-31 12:53:07 +02:00
Code Issues Packages Projects Releases Wiki Activity

gmain: repeat preconditions for emphasis

Browse Source 
g_main_context_acquire() mentions that you must have called it before
you make any calls to _prepare(), _query(), _check() or _dispatch().

For emphasis, add a note on each of those functions pointing back to the
fact that you must have called _acquire() before using them.
This commit is contained in:
Ryan Lortie 2014-02-22 09:22:27 -05:00
parent c0aa150cb0
commit 6147d15ea2
1 changed files with 19 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
glib/gmain.c
View File

@ -3287,10 +3287,13 @@ g_main_context_wait (GMainContext *context,
* @context: a #GMainContext * @context: a #GMainContext
* @priority: location to store priority of highest priority * @priority: location to store priority of highest priority
* source already ready. * source already ready.
* *
* Prepares to poll sources within a main loop. The resulting information * Prepares to poll sources within a main loop. The resulting information
* for polling is determined by calling g_main_context_query (). * for polling is determined by calling g_main_context_query ().
* *
* You must have successfully acquired the context with
* g_main_context_acquire() before you may call this function.
*
* Returns: %TRUE if some source is ready to be dispatched * Returns: %TRUE if some source is ready to be dispatched
* prior to polling. * prior to polling.
**/ **/
@ -3448,9 +3451,12 @@ g_main_context_prepare (GMainContext *context,
* @fds: (out caller-allocates) (array length=n_fds): location to * @fds: (out caller-allocates) (array length=n_fds): location to
* store #GPollFD records that need to be polled. * store #GPollFD records that need to be polled.
* @n_fds: length of @fds. * @n_fds: length of @fds.
* *
* Determines information necessary to poll this main loop. * Determines information necessary to poll this main loop.
* *
* You must have successfully acquired the context with
* g_main_context_acquire() before you may call this function.
*
* Returns: the number of records actually stored in @fds, * Returns: the number of records actually stored in @fds,
* or, if more than @n_fds records need to be stored, the number * or, if more than @n_fds records need to be stored, the number
* of records that need to be stored. * of records that need to be stored.
@ -3513,9 +3519,12 @@ g_main_context_query (GMainContext *context,
* @fds: (array length=n_fds): array of #GPollFD's that was passed to * @fds: (array length=n_fds): array of #GPollFD's that was passed to
* the last call to g_main_context_query() * the last call to g_main_context_query()
* @n_fds: return value of g_main_context_query() * @n_fds: return value of g_main_context_query()
* *
* Passes the results of polling back to the main loop. * Passes the results of polling back to the main loop.
* *
* You must have successfully acquired the context with
* g_main_context_acquire() before you may call this function.
*
* Returns: %TRUE if some sources are ready to be dispatched. * Returns: %TRUE if some sources are ready to be dispatched.
**/ **/
gboolean gboolean
@ -3659,8 +3668,11 @@ g_main_context_check (GMainContext *context,
/** /**
* g_main_context_dispatch: * g_main_context_dispatch:
* @context: a #GMainContext * @context: a #GMainContext
* *
* Dispatches all pending sources. * Dispatches all pending sources.
*
* You must have successfully acquired the context with
* g_main_context_acquire() before you may call this function.
**/ **/
void void
g_main_context_dispatch (GMainContext *context) g_main_context_dispatch (GMainContext *context)