alsa_write.c: Add missing documentation
authorAndre Noll <maan@systemlinux.org>
Mon, 5 Feb 2007 22:31:43 +0000 (23:31 +0100)
committerAndre Noll <maan@systemlinux.org>
Mon, 5 Feb 2007 22:31:43 +0000 (23:31 +0100)
alsa_write.c

index 7c090c8..8bac583 100644 (file)
@@ -36,7 +36,7 @@
 #include "alsa_write.cmdline.h"
 #include "error.h"
 
-
+/** always use 16 bit little endian */
 #define FORMAT SND_PCM_FORMAT_S16_LE
 
 /** data specific to the alsa writer */
@@ -49,7 +49,15 @@ struct private_alsa_write_data {
        struct timeval next_chunk;
        /** the return value of snd_pcm_hw_params_get_buffer_time_max() */
        unsigned buffer_time;
+       /**
+        * the samplerate given by command line option or the decoder
+        * of the writer node group
+        */
        unsigned samplerate;
+       /**
+        * the number of channels, also given by command line option or the
+        * decoder of the writer node group
+        */
        unsigned channels;
 };
 
@@ -227,7 +235,13 @@ err_out:
        return NULL;
 }
 
-/** the init function of the alsa writer */
+/**
+ * the init function of the alsa writer
+ *
+ * \param w pointer to the writer to initialize
+ *
+ * \sa struct writer
+ */
 void alsa_write_init(struct writer *w)
 {
        w->open = alsa_open;