shithub: aubio

Download patch

ref: 554e286ba56a931408b865b4a469e08069d70801
parent: 7893149495f6569f81d619e25230e0d8e13638f1
author: Paul Brossier <piem@piem.org>
date: Wed Nov 4 17:36:33 EST 2009

src/spectral/filterbank.h: improve documentation

--- a/src/spectral/filterbank.h
+++ b/src/spectral/filterbank.h
@@ -40,8 +40,8 @@
 
 /** 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);
@@ -48,7 +48,7 @@
 
 /** 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 @@
 
 /** 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);