summaryrefslogtreecommitdiffstats
path: root/src/polyp/glib-mainloop.h
diff options
context:
space:
mode:
authorPierre Ossman <ossman@cendio.se>2006-04-09 19:31:09 +0000
committerPierre Ossman <ossman@cendio.se>2006-04-09 19:31:09 +0000
commita6ce5c4b1d82870f5db7063680698cebb4ffe156 (patch)
treef60708ee269c4f11f0a7017896c8a63507166a5a /src/polyp/glib-mainloop.h
parenta74253606f4f5556e58cb12336d8900dd73226cc (diff)
Big documentation update. Describe the client API in a more tutorial like
manner. git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@667 fefdeb5f-60dc-0310-8127-8f9354f1896f
Diffstat (limited to 'src/polyp/glib-mainloop.h')
-rw-r--r--src/polyp/glib-mainloop.h11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/polyp/glib-mainloop.h b/src/polyp/glib-mainloop.h
index b7717685..bc66409b 100644
--- a/src/polyp/glib-mainloop.h
+++ b/src/polyp/glib-mainloop.h
@@ -27,6 +27,17 @@
#include <polyp/mainloop-api.h>
#include <polyp/cdecl.h>
+/** \page glib-mainloop GLIB main loop bindings
+ *
+ * \section overv_sec Overview
+ *
+ * The GLIB main loop bindings are extremely easy to use. All that is
+ * required is to create a pa_glib_mainloop object using
+ * pa_glib_mainloop_new(). When the main loop abstraction is needed, it is
+ * provided by pa_glib_mainloop_get_api().
+ *
+ */
+
/** \file
* GLIB main loop support */