Add documenatation of imdct_init().

[paraslash.git] / imdct.c

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