Documentation work

[pulseaudio] / polyp / polyplib-introspect.h

diff --git a/polyp/polyplib-introspect.h b/polyp/polyplib-introspect.h
index e83ba73b749ea557c22c28c41ede21e0d4133bb7..dfa24ed55a4cefc76a4b9fee77a0a53ac6e254ad 100644 (file)
--- a/polyp/polyplib-introspect.h
+++ b/polyp/polyplib-introspect.h
@@ -28,6 +28,9 @@
 #include "polyplib-context.h"
 #include "cdecl.h"
 
+/** \file
+ * Routines for daemon introspection. */
+
 PA_C_DECL_BEGIN
 
 struct pa_sink_info {
@@ -36,7 +39,7 @@ struct pa_sink_info {
     const char *description;
     struct pa_sample_spec sample_spec;
     uint32_t owner_module;
-    uint32_t volume;
+    pa_volume_t volume;
     uint32_t monitor_source;
     const char *monitor_source_name;
     uint32_t latency;
@@ -60,12 +63,13 @@ struct pa_operation* pa_context_get_source_info_by_name(struct pa_context *c, co
 struct pa_operation* pa_context_get_source_info_by_index(struct pa_context *c, uint32_t id, void (*cb)(struct pa_context *c, const struct pa_source_info *i, int is_last, void *userdata), void *userdata);
 struct pa_operation* pa_context_get_source_info_list(struct pa_context *c, void (*cb)(struct pa_context *c, const struct pa_source_info *i, int is_last, void *userdata), void *userdata);
 
+/** Server information */
 struct pa_server_info {
-    const char *user_name;
-    const char *host_name;
-    const char *server_version;
-    const char *server_name;
-    struct pa_sample_spec sample_spec;
+    const char *user_name;              /**< User name of the daemon process */
+    const char *host_name;              /**< Host name the daemon is running on */
+    const char *server_version;         /**< Version string of the daemon */
+    const char *server_name;            /**< Server package name (usually "polypaudio") */
+    struct pa_sample_spec sample_spec;  /**< Default sample specification */
 };
 
 struct pa_operation* pa_context_get_server_info(struct pa_context *c, void (*cb)(struct pa_context *c, const struct pa_server_info*i, void *userdata), void *userdata);
@@ -96,7 +100,7 @@ struct pa_sink_input_info {
     uint32_t client;
     uint32_t sink;
     struct pa_sample_spec sample_spec;
-    uint32_t volume;
+    pa_volume_t volume;
     uint32_t latency;
 };
 
@@ -115,15 +119,22 @@ struct pa_source_output_info {
 struct pa_operation* pa_context_get_source_output_info(struct pa_context *c, uint32_t index, void (*cb)(struct pa_context *c, const struct pa_source_output_info*i, int is_last, void *userdata), void *userdata);
 struct pa_operation* pa_context_get_source_output_info_list(struct pa_context *c, void (*cb)(struct pa_context *c, const struct pa_source_output_info*i, int is_last, void *userdata), void *userdata);
 
-struct pa_operation* pa_context_set_sink_volume_by_index(struct pa_context *c, uint32_t index, uint32_t volume, void (*cb)(struct pa_context *c, int success, void *userdata), void *userdata);
-struct pa_operation* pa_context_set_sink_volume_by_name(struct pa_context *c, const char *name, uint32_t volume, void (*cb)(struct pa_context *c, int success, void *userdata), void *userdata);
-struct pa_operation* pa_context_set_sink_input_volume(struct pa_context *c, uint32_t index, uint32_t volume, void (*cb)(struct pa_context *c, int success, void *userdata), void *userdata);
+/** Set the volume of a sink device specified by its index */
+struct pa_operation* pa_context_set_sink_volume_by_index(struct pa_context *c, uint32_t index, pa_volume_t volume, void (*cb)(struct pa_context *c, int success, void *userdata), void *userdata);
+
+/** Set the volume of a sink device specified by its name */
+struct pa_operation* pa_context_set_sink_volume_by_name(struct pa_context *c, const char *name, pa_volume_t volume, void (*cb)(struct pa_context *c, int success, void *userdata), void *userdata);
+
+/** Set the volume of a sink input stream */
+struct pa_operation* pa_context_set_sink_input_volume(struct pa_context *c, uint32_t index, pa_volume_t volume, void (*cb)(struct pa_context *c, int success, void *userdata), void *userdata);
 
+/** Memory block statistics */
 struct pa_stat_info {
-    uint32_t memblock_count;
-    uint32_t memblock_total;
+    uint32_t memblock_count; /**< Allocated memory blocks */
+    uint32_t memblock_total; /**< Total size of allocated memory blocks */
 };
 
+/** Get daemon memory block statistics */
 struct pa_operation* pa_context_stat(struct pa_context *c, void (*cb)(struct pa_context *c, const struct pa_stat_info *i, void *userdata), void *userdata);
 
 PA_C_DECL_END