From: Paul Brossier <piem@piem.org>
Date: Sun, 3 Mar 2013 03:53:15 +0000 (-0500)
Subject: src/spectral/*.h: add link to examples
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=b8c0685e23d0f31c8796ef4958bb167e55552216;p=aubio.git

src/spectral/*.h: add link to examples
---

diff --git a/src/spectral/fft.h b/src/spectral/fft.h
index 3ae4be8c..c61963c5 100644
--- a/src/spectral/fft.h
+++ b/src/spectral/fft.h
@@ -22,6 +22,8 @@
 
   Fast Fourier Transform object
 
+  \example src/spectral/test-fft.c
+
 */
 
 #ifndef FFT_H_
diff --git a/src/spectral/filterbank.c b/src/spectral/filterbank.c
index 13d7f6ea..39dfa5da 100644
--- a/src/spectral/filterbank.c
+++ b/src/spectral/filterbank.c
@@ -69,7 +69,6 @@ aubio_filterbank_do (aubio_filterbank_t * f, cvec_t * in, fvec_t * out)
 
   /* for each filter */
   for (fn = 0; fn < max_filters; fn++) {
-
     /* for each sample */
     for (j = 0; j < max_length; j++) {
       out->data[fn] += in->norm[j] * f->filters->data[fn][j];
diff --git a/src/spectral/filterbank.h b/src/spectral/filterbank.h
index 0799dc2a..6813faf4 100644
--- a/src/spectral/filterbank.h
+++ b/src/spectral/filterbank.h
@@ -25,6 +25,8 @@
 
   General-purpose spectral filterbank object.
 
+  \example spectral/test-filterbank.c
+
 */
 
 #ifndef FILTERBANK_H
@@ -35,7 +37,11 @@ extern "C"
 {
 #endif
 
-/** filterbank object */
+/** filterbank object
+
+  This object stores a matrix of spectral filter coefficients.
+
+ */
 typedef struct _aubio_filterbank_t aubio_filterbank_t;
 
 /** create filterbank object
diff --git a/src/spectral/filterbank_mel.h b/src/spectral/filterbank_mel.h
index 6d338cdd..d2e8876c 100644
--- a/src/spectral/filterbank_mel.h
+++ b/src/spectral/filterbank_mel.h
@@ -27,6 +27,8 @@
     - ::aubio_filterbank_set_triangle_bands: overlapping triangular bands,
     - ::aubio_filterbank_set_mel_coeffs_slaney: Mel frequency bands.
 
+  \example spectral/test-filterbank_mel.c
+
 */
 
 #ifndef FILTERBANK_MEL_H
diff --git a/src/spectral/mfcc.h b/src/spectral/mfcc.h
index a0d43c9b..004c0113 100644
--- a/src/spectral/mfcc.h
+++ b/src/spectral/mfcc.h
@@ -23,6 +23,8 @@
 
   Mel-frequency cepstrum coefficients object
 
+  \example spectral/test-mfcc.h
+
 */
 
 #ifndef MFCC_H
diff --git a/src/spectral/phasevoc.h b/src/spectral/phasevoc.h
index 17f85d46..cd4f739f 100644
--- a/src/spectral/phasevoc.h
+++ b/src/spectral/phasevoc.h
@@ -27,6 +27,8 @@
   phase relationships across frames. The window sizes and overlap are specified
   at creation time.
 
+  \example spectral/test-phasevoc.c
+
 */
 
 #ifndef _PHASEVOC_H