X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=mp3dec.c;h=16599411820313eae492a604fb58d09b1221b752;hp=5c6bab339e599152ccbba81d4873500fd8af7e3a;hb=ac4c4bfa02e9d8adfcc561dfd2377d7c138ce82f;hpb=471684761a2039bbc89aa1e3c33c62de6bef86cf;ds=sidebyside

diff --git a/mp3dec.c b/mp3dec.c
index 5c6bab33..16599411 100644
--- a/mp3dec.c
+++ b/mp3dec.c
@@ -4,7 +4,7 @@
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file mp3dec.c paraslash's mp3 decoder */
+/** \file mp3dec.c Paraslash's mp3 decoder. */
 
 #include "para.h"
 #include "list.h"
@@ -14,25 +14,20 @@
 #include <mad.h>
 #include "string.h"
 
-/** the output buffer size */
-#define MP3_OUTBUF_SIZE 128 * 1024
+/** The output buffer size. */
+#define MP3_OUTBUF_SIZE (128 * 1024)
 
-/** \cond a helper macro */
+/** Convert a sample value from libmad to a signed short. */
 #define MAD_TO_SHORT(f) (f) >= MAD_F_ONE? SHRT_MAX :\
 	(f) <= -MAD_F_ONE? -SHRT_MAX : (signed short) ((f) >> (MAD_F_FRACBITS - 15))
-/** \endcond */
 
-/**
- * data specific to the mp3dec filter
- *
- * \sa filter, filter_node
- */
+/** Data specific to the mp3dec filter. */
 struct private_mp3dec_data {
-	/** information on the current mp3 stream */
+	/** Information on the current mp3 stream. */
 	struct mad_stream stream;
-	/** information about the frame which is currently decoded */
+	/** Information about the frame which is currently decoded. */
 	struct mad_frame frame;
-	/** contains the PCM output */
+	/** Contains the PCM output. */
 	struct mad_synth synth;
 };
 
@@ -115,11 +110,11 @@ static void mp3dec_open(struct filter_node *fn)
 }
 
 /**
- * the init function of the mp3dec filter
+ * The init function of the mp3dec filter.
  *
- * \param f pointer to the filter struct to initialize
+ * \param f Pointer to the filter struct to initialize.
  *
- * \sa filter::init
+ * \sa filter::init.
  */
 void mp3dec_init(struct filter *f)
 {