From: Paul Brossier <piem@piem.org>
Date: Fri, 25 Sep 2009 21:00:44 +0000 (+0200)
Subject: src/spectral/mfcc.{c,h}: add documentation
X-Git-Tag: bzr2git~300
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=d99d8190b578914dc4dd23ffa3bf0b1a5fa6b277;p=aubio.git

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

diff --git a/src/spectral/mfcc.c b/src/spectral/mfcc.c
index b7dca023..64260d69 100644
--- 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 19946928..875da231 100644
--- 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,