More documentation updates.
authorAndre Noll <maan@systemlinux.org>
Tue, 20 Oct 2009 17:15:27 +0000 (19:15 +0200)
committerAndre Noll <maan@systemlinux.org>
Wed, 18 Nov 2009 18:34:27 +0000 (19:34 +0100)
imdct.c
imdct.h
wma.h

diff --git a/imdct.c b/imdct.c
index db7a6d5..ac085bb 100644 (file)
--- a/imdct.c
+++ b/imdct.c
@@ -39,13 +39,15 @@ struct fft_context {
 };
 
 struct mdct_context {
-       /** Size of MDCT (i.e. number of input data * 2). */
+       /** Size of MDCT (number of input data * 2). */
        int n;
        /** n = 2^n bits. */
        int nbits;
-       /** pre/post rotation tables */
+       /** Cosine table for pre/post rotation. */
        fftsample_t *tcos;
+       /** Sine table for pre/post rotation. */
        fftsample_t *tsin;
+       /** The context for the underlying fast Fourier transform. */
        struct fft_context fft;
 };
 
@@ -85,7 +87,8 @@ static int split_radix_permutation(int i, int n)
                return split_radix_permutation(i, m) * 4 - 1;
 }
 
-#define SQRTHALF (float)0.70710678118654752440 /* 1/sqrt(2) */
+/** 1 / sqrt(2). */
+#define SQRTHALF (float)0.70710678118654752440
 
 #define BF(x,y,a,b) {\
     x = a - b;\
@@ -384,6 +387,11 @@ fail:
        return ret;
 }
 
+/**
+ * Deallocate imdct resources.
+ *
+ * \param ctx The pointer obtained by imdct_init().
+ */
 void imdct_end(struct mdct_context *ctx)
 {
        free(ctx->tcos);
diff --git a/imdct.h b/imdct.h
index 6a71a5a..442b98b 100644 (file)
--- a/imdct.h
+++ b/imdct.h
@@ -1,4 +1,4 @@
-/** \file imdct.h: Exported symbols from imdct.c. */
+/** \file imdct.h Exported symbols from imdct.c. */
 
 struct mdct_context;
 
diff --git a/wma.h b/wma.h
index 18748da..df61c20 100644 (file)
--- a/wma.h
+++ b/wma.h
@@ -1,10 +1,10 @@
+/** \file wma.h The asf_header structure and public wma function declarations. */
+
 /**
  * Information contained in an asf audio file header.
  *
  * Both para_filter and para_afh need to read the header.
  */
-
-/** Information stored in the asf header. */
 struct asf_header_info {
        /** The size of the audio file header. */
        int header_len;