Changeset c799138 in mainline for uspace/srv/audio/hound/connection.c

Timestamp:

2013-04-11T01:34:41Z (12 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

250828a

Parents:

f0a647c

Message:

hound: doxygen and cleanup

File:

• uspace/srv/audio/hound/connection.c (modified) (3 diffs)

uspace/srv/audio/hound/connection.c

@@ -40 +40 @@
 #include "connection.h"
 
+/**
+ * Create connection between source and sink.
+ * @param source Valid source structure.
+ * @param sink Valid sink structure.
+ * @return pointer to a valid connection structure, NULL on failure.
+ *
+ * Reports new connection to both the source and sink.
+ */
 connection_t *connection_create(audio_source_t *source, audio_sink_t *sink)
 {
@@ -64 +72 @@
 }
 
+/**
+ * Destroy existing connection
+ * @param connection The connection to destroy.
+ *
+ * Disconnects from both the source and the sink.
+ */
 void connection_destroy(connection_t *connection)
 {
@@ -80 +94 @@
 }
 
+/**
+ * Update and mix data provided by the source.
+ * @param connection the connection to add.
+ * @param data Destination audio buffer.
+ * @param size size of the destination audio buffer.
+ * @param format format of the destination audio buffer.
+ */
 ssize_t connection_add_source_data(connection_t *connection, void *data,
     size_t size, pcm_format_t format)