docs: fix GSourceFuncs docs
authorDieter Verfaillie <dieterv@optionexplicit.be>
Fri, 20 Sep 2013 19:07:28 +0000 (21:07 +0200)
committerDieter Verfaillie <dieterv@optionexplicit.be>
Fri, 20 Sep 2013 19:08:20 +0000 (21:08 +0200)
"returns" at the start of a description continuation
line seems to confuse GTK-Doc's parser. Rearrange
the text a bit to work around this...

https://bugzilla.gnome.org/show_bug.cgi?id=708445

glib/gmain.h

index 558910a..c455353 100644 (file)
@@ -85,18 +85,18 @@ typedef struct _GSourceCallbackFuncs    GSourceCallbackFuncs;
  *     results of the poll() call) it should return %TRUE. It can also return
  *     a @timeout_ value which should be the maximum timeout (in milliseconds)
  *     which should be passed to the poll() call. The actual timeout used will
- *     be -1 if all sources returned -1, or it will be the minimum of all the
- *     @timeout_ values returned which were >= 0.  Since 2.36 this may
- *     be %NULL, in which case the effect is as if the function always
- *     returns %FALSE with a timeout of -1.  If @prepare returns a
+ *     be -1 if all sources returned -1, or it will be the minimum of all
+ *     the @timeout_ values returned which were >= 0.  Since 2.36 this may
+ *     be %NULL, in which case the effect is as if the function always returns
+ *     %FALSE with a timeout of -1.  If @prepare returns a
  *     timeout and the source also has a 'ready time' set then the
  *     nearer of the two will be used.
  * @check: Called after all the file descriptors are polled. The source
  *     should return %TRUE if it is ready to be dispatched. Note that 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
- *     be %NULL, in which case the effect is as if the function always
- *     returns %FALSE.
+ *     be %NULL, in which case the effect is as if the function always returns
+ *     %FALSE.
  * @dispatch: Called to dispatch the event source, after it has returned
  *     %TRUE in either its @prepare or its @check function. The @dispatch
  *     function is passed in a callback function and data. The callback