imdct.c: Add some more documentation.

diff --git a/imdct.c b/imdct.c
index 8bb52d955c90dea5861bd490ad7a2e5b4a84bf12..6e0360b8b9018d951c7f1062b6411d4d48c80f76 100644 (file)
--- a/imdct.c
+++ b/imdct.c
@@ -29,12 +29,19 @@
 
 typedef float fftsample_t;
 
 
 typedef float fftsample_t;
 

+/** Canonical representation of a complex number. */

 struct fft_complex {
 struct fft_complex {

-       fftsample_t re, im;
+       /** Real part. */
+       fftsample_t re;
+       /** Imaginary part. */
+       fftsample_t im;

 };
 
 };
 

+/** FFT Lookup table. */

 struct fft_context {
 struct fft_context {

+       /** Number of bits of this instance of the FFT. */

        int nbits;
        int nbits;

+       /** The lookup table for cosine values. */

        uint16_t *revtab;
 };
 
        uint16_t *revtab;
 };