imdct.c: Add some more documentation.
authorAndre Noll <maan@systemlinux.org>
Sat, 14 Nov 2009 11:47:41 +0000 (12:47 +0100)
committerAndre Noll <maan@systemlinux.org>
Wed, 18 Nov 2009 18:34:31 +0000 (19:34 +0100)
imdct.c

diff --git a/imdct.c b/imdct.c
index 8bb52d9..6e0360b 100644 (file)
--- a/imdct.c
+++ b/imdct.c
 
 typedef float fftsample_t;
 
+/** Canonical representation of a complex number. */
 struct fft_complex {
-       fftsample_t re, im;
+       /** Real part. */
+       fftsample_t re;
+       /** Imaginary part. */
+       fftsample_t im;
 };
 
+/** FFT Lookup table. */
 struct fft_context {
+       /** Number of bits of this instance of the FFT. */
        int nbits;
+       /** The lookup table for cosine values. */
        uint16_t *revtab;
 };