]> code.delx.au - pulseaudio/blobdiff - polyp/polyplib-simple.h
Documentation work
[pulseaudio] / polyp / polyplib-simple.h
index ee2e27e3f61ccc18696e503e83de607b87519afc..ed552cb468f878cab4f5c83ce9e6880f93169c6a 100644 (file)
 #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 */