X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=alsa_write.c;h=526cffc1aeaede74968d0f5e1ec89057dd8933b1;hp=7c090c899915cf454abad3c459dc45f0973239f8;hb=5430c77f1fdf97d92796f44623d257b8124bde24;hpb=2e8b7f42a30ebe41c862cc603c8f746b1e202479

diff --git a/alsa_write.c b/alsa_write.c
index 7c090c89..526cffc1 100644
--- a/alsa_write.c
+++ b/alsa_write.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
  *
  *     This program is free software; you can redistribute it and/or modify
  *     it under the terms of the GNU General Public License as published by
@@ -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;