add doxygen documentation for ext-stream-restore.h

[pulseaudio] / src / pulse / ext-stream-restore.h

diff --git a/src/pulse/ext-stream-restore.h b/src/pulse/ext-stream-restore.h
index a8eceaf173336795964b8290af32a55ffcece810..2038eb4a1776ae43c0d5b4c39859caa1eb28cd07 100644 (file)
--- a/src/pulse/ext-stream-restore.h
+++ b/src/pulse/ext-stream-restore.h
@@ -24,37 +24,49 @@
 
 #include <pulse/context.h>
 
+/** \file
+ *
+ * Routines for controlling module-stream-restore
+ */
+
 PA_C_DECL_BEGIN
 
+/** Stores information about one entry in the stream database that is
+ * maintained by module-stream-restore. \since 0.9.12 */
 typedef struct pa_ext_stream_restore_info {
-    const char *name;
-    pa_channel_map channel_map;
-    pa_cvolume volume;
-    const char *device;
-    int mute;
+    const char *name;            /**< Identifier string of the stream. A string like "sink-input-by-role:" or similar followed by some arbitrary property value. */
+    pa_channel_map channel_map;  /**< The channel map for the volume field */
+    pa_cvolume volume;           /**< The volume of the stream when it was seen last, if applicable */
+    const char *device;          /**< The sink/source of the stream when it was last seen */
+    int mute;                    /**< The boolean mute state of the stream when it was last seen, if applicable */
 } pa_ext_stream_restore_info;
 
+/** Callback prototype for pa_ext_stream_restore_test(). \since 0.9.12 */
 typedef void (*pa_ext_stream_restore_test_cb_t)(
         pa_context *c,
         uint32_t version,
         void *userdata);
 
+/** Test if this extension module is available in the server. \since 0.9.12 */
 pa_operation *pa_ext_stream_restore_test(
         pa_context *c,
         pa_ext_stream_restore_test_cb_t cb,
         void *userdata);
 
+/** Callback prototype for pa_ext_stream_restore_read(). \since 0.9.12 */
 typedef void (*pa_ext_stream_restore_read_cb_t)(
         pa_context *c,
         const pa_ext_stream_restore_info *info,
         int eol,
         void *userdata);
 
+/** Read all entries from the stream database. \since 0.9.12 */
 pa_operation *pa_ext_stream_restore_read(
         pa_context *c,
         pa_ext_stream_restore_read_cb_t cb,
         void *userdata);
 
+/** Store entries in the stream database. \since 0.9.12 */
 pa_operation *pa_ext_stream_restore_write(
         pa_context *c,
         pa_update_mode_t mode,
@@ -64,22 +76,27 @@ pa_operation *pa_ext_stream_restore_write(
         pa_context_success_cb_t cb,
         void *userdata);
 
+/** Delete entries from the stream database. \since 0.9.12 */
 pa_operation *pa_ext_stream_restore_delete(
         pa_context *c,
         const char *const s[],
         pa_context_success_cb_t cb,
         void *userdata);
 
+/** Subscribe to changes in the stream database. \since 0.9.12 */
 pa_operation *pa_ext_stream_restore_subscribe(
         pa_context *c,
         int enable,
         pa_context_success_cb_t cb,
         void *userdata);
 
+/** Callback prototype for pa_ext_stream_restore_set_subscribe_cb(). \since 0.9.12 */
 typedef void (*pa_ext_stream_restore_subscribe_cb_t)(
         pa_context *c,
         void *userdata);
 
+/** Set the subscription callback that is called when
+ * pa_ext_stream_restore_subscribe() was called. \since 0.9.12 */
 void pa_ext_stream_restore_set_subscribe_cb(
         pa_context *c,
         pa_ext_stream_restore_subscribe_cb_t cb,