ref: 76ac3731c5c659712e705d08bcae6e42ac1fdec8
parent: c698d1bdd6679626726089cc81e2776751ffeadb
author: Paul Brossier <piem@piem.org>
date: Fri Sep 25 19:46:19 EDT 2009
src/temporal/: improve documentation for a and c-design filters
--- 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
--- 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