Improve the docs. (#491974, Areg Beketovski)

2007-11-09  Matthias Clasen <mclasen@redhat.com>

        * glib/gmain.c (g_main_context_iteration): Improve the
        docs.  (#491974, Areg Beketovski)



svn path=/trunk/; revision=5850
This commit is contained in:
Matthias Clasen 2007-11-10 00:23:16 +00:00 committed by Matthias Clasen
parent 0a967d39e7
commit 4abb6c13be
2 changed files with 13 additions and 4 deletions

View File

@ -1,3 +1,8 @@
2007-11-09 Matthias Clasen <mclasen@redhat.com>
* glib/gmain.c (g_main_context_iteration): Improve the
docs. (#491974, Areg Beketovski)
2007-11-09 Matthias Clasen <mclasen@redhat.com>
* glib/gdate.c: Coding style fixes.

View File

@ -2737,10 +2737,14 @@ g_main_context_pending (GMainContext *context)
* checking to see if any event sources are ready to be processed,
* then if no events sources are ready and @may_block is %TRUE, waiting
* for a source to become ready, then dispatching the highest priority
* events sources that are ready. Note that even when @may_block is %TRUE,
* it is still possible for g_main_context_iteration() to return
* %FALSE, since the the wait may be interrupted for other
* reasons than an event source becoming ready.
* events sources that are ready. Otherwise, if @may_block is %FALSE
* sources are not waited to become ready, only those highest priority
* events sources will be dispatched (if any), that are ready at this
* given moment without further waiting.
*
* Note that even when @may_block is %TRUE, it is still possible for
* g_main_context_iteration() to return %FALSE, since the the wait may
* be interrupted for other reasons than an event source becoming ready.
*
* Return value: %TRUE if events were dispatched.
**/