fix doxygen comment of the init functions of all audio format handlers.
[paraslash.git] / mp3dec.c
index 1818d4c06a91532cbeae556d0201616fd89fc981..401a03c582f418d6590a7fc27007becdfab6d73d 100644 (file)
--- a/mp3dec.c
+++ b/mp3dec.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
@@ -30,7 +30,7 @@
 #define MP3_OUTBUF_SIZE 128 * 1024
 
 /** \cond a helper macro */
-#define MAD_TO_SHORT(f) (f) >= MAD_F_ONE?  SHRT_MAX :\
+#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 */
 
@@ -48,7 +48,6 @@ struct private_mp3dec_data {
        struct mad_synth synth;
 };
 
-/* TODO: Convert all input if possible */
 static ssize_t mp3dec(char *inbuffer, size_t len, struct filter_node *fn)
 {
        int i, ret;
@@ -127,9 +126,12 @@ static void mp3dec_open(struct filter_node *fn)
        fn->bufsize = MP3_OUTBUF_SIZE;
        fn->buf = para_calloc(fn->bufsize);
 }
+
 /**
  * the init function of the mp3dec filter
  *
+ * \param f pointer to the filter struct to initialize
+ *
  * \sa filter::init
  */
 void mp3dec_init(struct filter *f)