Changeset 76ac373 for src

Timestamp:

Sep 25, 2009, 11:46:19 PM (15 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, pitchshift, sampler, timestretch, yinfft+

Children:

a6db140

Parents:

c698d1b

Message:

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

Location:

src/temporal

Files:

• adesign.h (modified) (1 diff)
• cdesign.h (modified) (1 diff)

src/temporal/adesign.h

@@ -18 +18 @@
 */
 
-/** 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

src/temporal/cdesign.h

@@ -20 +20 @@
 #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