From: Paul Brossier Date: Wed, 4 Nov 2009 21:36:33 +0000 (+0100) Subject: src/spectral/filterbank.h: improve documentation X-Git-Tag: 0.4.0-beta1~573 X-Git-Url: https://git.aubio.org/?a=commitdiff_plain;h=554e286ba56a931408b865b4a469e08069d70801;p=aubio.git src/spectral/filterbank.h: improve documentation --- diff --git a/src/spectral/filterbank.h b/src/spectral/filterbank.h index 8ea93c19..29cbdf0d 100644 --- a/src/spectral/filterbank.h +++ b/src/spectral/filterbank.h @@ -40,15 +40,15 @@ typedef struct _aubio_filterbank_t aubio_filterbank_t; /** create filterbank object - \param win_s size of analysis buffer (and length the FFT transform) \param n_filters number of filters to create + \param win_s size of analysis buffer (and length the FFT transform) */ aubio_filterbank_t *new_aubio_filterbank (uint_t n_filters, uint_t win_s); /** destroy filterbank object - \param fb filterbank, as returned by new_aubio_filterbank method + \param fb filterbank, as returned by new_aubio_filterbank() method */ void del_aubio_filterbank (aubio_filterbank_t * fb); @@ -71,7 +71,8 @@ fvec_t *aubio_filterbank_get_coeffs (aubio_filterbank_t * f); /** copy filter coefficients to the filterbank - \param f filterbank object to get coefficients from + \param f filterbank object to set coefficients + \param filters filter bank coefficients to copy from */ uint_t aubio_filterbank_set_coeffs (aubio_filterbank_t * f, fvec_t * filters);