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

diff --git a/ChangeLog b/ChangeLog
index 24cbcbed37d4cfa53e1e3684529ecab36c287d3d..bddfbfa9ecc682a2bff60d5a5420e7b7800e4345 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -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.

diff --git a/glib/gmain.c b/glib/gmain.c
index 6d077c97016a49aa44d225d76a01e1495edee5ec..52b1c21eb900c2baa4165df8aa8d9c0580220232 100644 (file)
--- a/glib/gmain.c
+++ b/glib/gmain.c
@@ -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.
  **/