Add documenatation of imdct_init().
authorAndre Noll <maan@systemlinux.org>
Sat, 17 Oct 2009 15:51:04 +0000 (17:51 +0200)
committerAndre Noll <maan@systemlinux.org>
Wed, 18 Nov 2009 18:34:17 +0000 (19:34 +0100)
imdct.c

diff --git a/imdct.c b/imdct.c
index 702d3d2..2d45263 100644 (file)
--- a/imdct.c
+++ b/imdct.c
@@ -343,6 +343,12 @@ static int fft_init(struct fft_context *s, int nbits)
 
 /**
  * Initialize the inverse modified cosine transform.
+ *
+ * \param nbits The number of bits to use (4 <= \a nbits <= 18).
+ *
+ * \param result Opaque structure that must be passed to \ref imdct().
+ *
+ * \return Standard.
  */
 int imdct_init(int nbits, struct mdct_context **result)
 {