From: Andre Noll <maan@systemlinux.org>
Date: Sat, 17 Oct 2009 15:51:04 +0000 (+0200)
Subject: Add documenatation of imdct_init().
X-Git-Tag: v0.4.1~85
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=cc5991f63ae366eee0b1694ba849080ea987c5db

Add documenatation of imdct_init().
---

diff --git a/imdct.c b/imdct.c
index 702d3d21..2d452630 100644
--- 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)
 {