src/temporal: improve documentation

diff --git a/src/temporal/a_weighting.h b/src/temporal/a_weighting.h
index eaee4b0cc6fc88ae99df9bb437888964e791fa2b..d1a541ab833856c1e9ed3201c75556d3291d3939 100644 (file)
--- a/src/temporal/a_weighting.h
+++ b/src/temporal/a_weighting.h
@@ -60,10 +60,10 @@ extern "C" {
 
 /** create new A-design filter
 
+  \param channels number of channels to allocate
   \param samplerate sampling frequency of the signal to filter. Should be one of 
   8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000, 88200, 96000, and
   192000 Hz
-  \param channels number of channels to allocate
 
   \return a new filter object
 
@@ -74,6 +74,9 @@ aubio_filter_t *new_aubio_filter_a_weighting (uint_t channels,
 /** set feedback and feedforward coefficients of a A-weighting filter
 
   \param f filter object to get coefficients from
+  \param samplerate sampling frequency of the signal to filter. Should be one of 
+  8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000, 88200, 96000, and
+  192000 Hz
 
 */
 uint_t aubio_filter_set_a_weighting (aubio_filter_t *f, uint_t samplerate);

diff --git a/src/temporal/biquad.h b/src/temporal/biquad.h
index 94f6fd9a333a77d716396ede53ec07b1c5d61ab5..c883dc94364bc6801bd0015e2436a53f15b7ef7a 100644 (file)
--- a/src/temporal/biquad.h
+++ b/src/temporal/biquad.h
@@ -42,6 +42,7 @@ extern "C" {
 
 /** set coefficients of a biquad filter
 
+  \param f filter object as returned by new_aubio_filter()
   \param b0 forward filter coefficient
   \param b1 forward filter coefficient
   \param b2 forward filter coefficient
@@ -60,6 +61,7 @@ aubio_filter_set_biquad (aubio_filter_t * f, lsmp_t b0, lsmp_t b1, lsmp_t b2,
   \param b2 forward filter coefficient
   \param a1 feedback filter coefficient
   \param a2 feedback filter coefficient
+  \param channels number of channels to allocate
 
 */
 aubio_filter_t *

diff --git a/src/temporal/c_weighting.h b/src/temporal/c_weighting.h
index ddb0bf30e46adbce597c6d1722e7e7243f0acf74..d3956e82331634a292756df772faebd205668096 100644 (file)
--- a/src/temporal/c_weighting.h
+++ b/src/temporal/c_weighting.h
@@ -60,10 +60,10 @@ extern "C" {
 
 /** create new C-design filter
 
+  \param channels number of channels to allocate
   \param samplerate sampling frequency of the signal to filter. Should be one of 
   8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000, 88200, 96000, and
   192000 Hz
-  \param channels number of channels to allocate
 
   \return a new filter object
 
@@ -73,6 +73,9 @@ aubio_filter_t * new_aubio_filter_c_weighting (uint_t channels, uint_t samplerat
 /** set feedback and feedforward coefficients of a C-weighting filter
 
   \param f filter object to get coefficients from
+  \param samplerate sampling frequency of the signal to filter. Should be one of 
+  8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000, 88200, 96000, and
+  192000 Hz
 
 */
 uint_t aubio_filter_set_c_weighting (aubio_filter_t *f, uint_t samplerate);

diff --git a/src/temporal/filter.h b/src/temporal/filter.h
index 633ec812a7d0d4bdd85954752c03b3247c4a0365..396e9615db28c107c8eaa09ae4eb27ec1811fd64 100644 (file)
--- a/src/temporal/filter.h
+++ b/src/temporal/filter.h
@@ -56,6 +56,7 @@
   Some convenience functions are provided: 
     - new_aubio_filter_a_weighting() and aubio_filter_set_a_weighting(),
     - new_aubio_filter_c_weighting() and aubio_filter_set_c_weighting().
+    - new_aubio_filter_biquad() and aubio_filter_set_biquad().
  
 */
 
@@ -140,7 +141,11 @@ uint_t aubio_filter_get_samplerate (aubio_filter_t * f);
 */
 uint_t aubio_filter_set_samplerate (aubio_filter_t * f, uint_t samplerate);
 
-/** reset filter memory */
+/** reset filter memory
+
+  \param f filter object as returned by new_aubio_filter()
+
+*/
 void aubio_filter_do_reset (aubio_filter_t * f);
 
 /** create new filter object
@@ -148,7 +153,6 @@ void aubio_filter_do_reset (aubio_filter_t * f);
   This function creates a new ::aubio_filter_t object, given an order 
   and a specific number of channels.
 
-  \param samplerate signal sampling rate
   \param order order of the filter (number of coefficients)
   \param channels number of channels to allocate