Changeset c799138 in mainline for uspace/srv/audio/hound/audio_source.h

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/audio_source.h (modified) (1 diff)

uspace/srv/audio/hound/audio_source.h

@@ -42 +42 @@
 typedef struct audio_source audio_source_t;
 
+/** Audio data source abstraction structure */
 struct audio_source {
+        /** Link in hound's sources list */
         link_t link;
+        /** List of connections */
         list_t connections;
+        /** String identifier */
         const char *name;
+        /** audio data format */
         pcm_format_t format;
+        /** backend data */
         void *private_data;
+        /** Callback for connection and disconnection */
         int (*connection_change)(audio_source_t *source, bool added);
+        /** Ask backend for more data */
         int (*update_available_data)(audio_source_t *source, size_t size);
 };
 
+/**
+ * List instance helper.
+ * @param l link
+ * @return pointer to a source structure, NULL on failure.
+ */
 static inline audio_source_t * audio_source_list_instance(link_t *l)
 {