fix doxygen comment of the init functions of all audio format handlers.

[paraslash.git] / aacdec.c

diff --git a/aacdec.c b/aacdec.c
index edbe2637521f59bc1f7403bf06e110a7a85d15df..9ed120120de7af297a0760ad237135ae535a72af 100644 (file)
--- a/aacdec.c
+++ b/aacdec.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-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
@@ -34,6 +34,7 @@
 /** the output buffer size */
 #define AAC_OUTBUF_SIZE (32 * 1024)
 
+/** give up decoding after that many errors */
 #define MAX_ERRORS 20
 
 /**
@@ -42,13 +43,22 @@
  * \sa filter, filter_node
  */
 struct private_aacdec_data {
+       /** the return value of aac_open */
        NeAACDecHandle handle;
+       /** info about the currently decoded frame */
        NeAACDecFrameInfo frame_info;
-
+       /** whether this instance of the aac decoder is already initialized */
        int initialized;
+       /**
+        * return value of aac_find_esds(). Used to call the right aacdec
+        * init function
+        */
        int decoder_length;
+       /** number of times the decoder returned an error */
        unsigned error_count;
+       /** number of bytes already consumed from the imput stream */
        size_t consumed_total;
+       /** return value of aac_find_entry_point */
        size_t entry;
 };
 
@@ -179,6 +189,8 @@ static void aacdec_close(struct filter_node *fn)
 /**
  * the init function of the aacdec filter
  *
+ * \param f pointer to the filter struct to initialize
+ *
  * \sa filter::init
  */
 void aacdec_init(struct filter *f)