From f2484293fd31da67792c858fee10792d3c108908 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Tue, 20 Oct 2009 19:15:27 +0200 Subject: [PATCH] More documentation updates. --- imdct.c | 14 +++++++++++--- imdct.h | 2 +- wma.h | 4 ++-- 3 files changed, 14 insertions(+), 6 deletions(-) diff --git a/imdct.c b/imdct.c index db7a6d5c..ac085bbc 100644 --- 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 6a71a5ad..442b98bf 100644 --- 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 18748dad..df61c20a 100644 --- 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; -- 2.30.2