more documentation updates

[pulseaudio] / src / polyp / mainloop.h

diff --git a/src/polyp/mainloop.h b/src/polyp/mainloop.h
index 6fb2a96cd284367f63f8eee65a9aa0c0fe7c7d9d..fe2b4c5b4863c1c233c63dfc11e76ffbb003202b 100644 (file)
--- a/src/polyp/mainloop.h
+++ b/src/polyp/mainloop.h
@@ -27,7 +27,7 @@
 
 PA_C_DECL_BEGIN
 
-/** \page mainloop Mainloop
+/** \page mainloop Main Loop
  *
  * \section overv_sec Overview
  *
@@ -81,15 +81,13 @@ void pa_mainloop_free(pa_mainloop* m);
 
 /** Prepare for a single iteration of the main loop. Returns a negative value
 on error or exit request. timeout specifies a maximum timeout for the subsequent
-poll, or -1 for blocking behaviour. Defer events are also dispatched when this
-function is called. On success returns the number of source dispatched in this
-iteration.*/
+poll, or -1 for blocking behaviour. .*/
 int pa_mainloop_prepare(pa_mainloop *m, int timeout);
 
 /** Execute the previously prepared poll. Returns a negative value on error.*/
 int pa_mainloop_poll(pa_mainloop *m);
 
-/** Dispatch timeout and io events from the previously executed poll. Returns
+/** Dispatch timeout, io and deferred events from the previously executed poll. Returns
 a negative value on error. On success returns the number of source dispatched. */
 int pa_mainloop_dispatch(pa_mainloop *m);
 
@@ -101,7 +99,7 @@ for pa_mainloop_prepare(), pa_mainloop_poll() and pa_mainloop_dispatch().
 Returns a negative value on error or exit request. If block is nonzero,
 block for events if none are queued. Optionally return the return value as
 specified with the main loop's quit() routine in the integer variable retval points
-to. On success returns the number of source dispatched in this iteration. */
+to. On success returns the number of sources dispatched in this iteration. */
 int pa_mainloop_iterate(pa_mainloop *m, int block, int *retval);
 
 /** Run unlimited iterations of the main loop object until the main loop's quit() routine is called. */