src/spectral/mfcc.{c,h}: add documentation

diff --git a/src/spectral/mfcc.c b/src/spectral/mfcc.c
index b7dca023e321ef649493c9eeb37e83b3eb79943a..64260d69806925fa648f939312b81ac17313289d 100644 (file)
--- a/src/spectral/mfcc.c
+++ b/src/spectral/mfcc.c
@@ -28,7 +28,7 @@
 
 /** Internal structure for mfcc object */
 
-struct aubio_mfcc_t_
+struct _aubio_mfcc_t
 {
   uint_t win_s;             /** grain length */
   uint_t samplerate;        /** sample rate (needed?) */

diff --git a/src/spectral/mfcc.h b/src/spectral/mfcc.h
index 199469287095087c4adb6c5b7546b83b69f5fcee..875da23187ec65ea6e6dae4ff189b46743fc2ce6 100644 (file)
--- a/src/spectral/mfcc.h
+++ b/src/spectral/mfcc.h
@@ -19,6 +19,12 @@
 
 */
 
+/** \file
+
+  Mel-frequency cepstrum coefficients object
+
+*/
+
 #ifndef MFCC_H
 #define MFCC_H
 
@@ -27,13 +33,15 @@ extern "C"
 {
 #endif
 
-typedef struct aubio_mfcc_t_ aubio_mfcc_t;
+/** mfcc object */
+typedef struct _aubio_mfcc_t aubio_mfcc_t;
 
 /** create mfcc object
 
   \param win_s size of analysis buffer (and length the FFT transform)
   \param samplerate audio sampling rate
-  \param n_coefs number of desired coefficientss
+  \param n_coefs number of desired coefficients
+  \param n_filters number of desired filters
 
 */
 aubio_mfcc_t *new_aubio_mfcc (uint_t win_s, uint_t samplerate,