From: Paul Brossier <piem@piem.org>
Date: Fri, 25 Sep 2009 21:46:19 +0000 (+0200)
Subject: src/temporal/: improve documentation for a and c-design filters
X-Git-Tag: bzr2git~295
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=76ac3731c5c659712e705d08bcae6e42ac1fdec8;p=aubio.git

src/temporal/: improve documentation for a and c-design filters
---

diff --git a/src/temporal/adesign.h b/src/temporal/adesign.h
index 910d6f7e..b0aa4242 100644
--- a/src/temporal/adesign.h
+++ b/src/temporal/adesign.h
@@ -17,12 +17,23 @@
 
 */
 
-/** create a new A-design filter 
+/** \file
+
+  Create a new A-design filter 
+
+  This file creates an IIR filter object with A-design coefficients.
+
+*/
+
+/** create new A-design filter
 
   \param samplerate sampling-rate of the signal to filter 
+  \param channels number of channels to allocate
 
 */
 aubio_filter_t * new_aubio_adsgn_filter(uint_t samplerate, uint_t channels);
 
+/** filter input vector (in-place) */
 #define aubio_adsgn_filter_do aubio_filter_do
+/** delete a-design filter object */
 #define del_aubio_adsgn_filter del_aubio_filter
diff --git a/src/temporal/cdesign.h b/src/temporal/cdesign.h
index f07f62f7..df40edee 100644
--- a/src/temporal/cdesign.h
+++ b/src/temporal/cdesign.h
@@ -19,12 +19,23 @@
 
 #include "filter.h"
 
-/** create a new C-design filter 
+/** \file
+
+  Create a new C-design filter 
+
+  This file creates an IIR filter object with A-design coefficients.
+
+*/
+
+/** create new C-design filter
 
   \param samplerate sampling-rate of the signal to filter 
+  \param channels number of channels to allocate
 
 */
 aubio_filter_t * new_aubio_cdsgn_filter(uint_t samplerate, uint_t channels);
 
+/** filter input vector (in-place) */
 #define aubio_cdsgn_filter_do aubio_filter_do
+/** delete c-design filter object */
 #define del_aubio_cdsgn_filter del_aubio_filter