summaryrefslogtreecommitdiffstats
path: root/polyp/polyplib-simple.h
diff options
context:
space:
mode:
Diffstat (limited to 'polyp/polyplib-simple.h')
-rw-r--r--polyp/polyplib-simple.h12
1 files changed, 10 insertions, 2 deletions
diff --git a/polyp/polyplib-simple.h b/polyp/polyplib-simple.h
index ee2e27e3..ed552cb4 100644
--- a/polyp/polyplib-simple.h
+++ b/polyp/polyplib-simple.h
@@ -29,12 +29,20 @@
#include "cdecl.h"
/** \file
- * A simple but limited synchronous playback and recording API. */
+ * A simple but limited synchronous playback and recording
+ * API. This is synchronouse, simplified wrapper around the standard
+ * asynchronous API. */
+
+/** \example pacat-simple.c
+ * A simple playback tool using the simple API */
+
+/** \example parec-simple.c
+ * A simple recording tool using the simple API */
PA_C_DECL_BEGIN
/** \struct pa_simple
- * A simple connection object */
+ * An opaque simple connection object */
struct pa_simple;
/** Create a new connection to the server */