summaryrefslogtreecommitdiffstats
path: root/src/polyp/glib-mainloop.h
diff options
context:
space:
mode:
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 */