src/{c,l}vec.h: update documentation
authorPaul Brossier <piem@piem.org>
Fri, 25 Sep 2009 21:37:02 +0000 (23:37 +0200)
committerPaul Brossier <piem@piem.org>
Fri, 25 Sep 2009 21:37:02 +0000 (23:37 +0200)
src/cvec.h
src/lvec.h

index 13ca3e348d6fbc352c398a8a0d641208fecfbd8d..6dbbd6961583ca8e0f03c168b17d307c7584fb29 100644 (file)
@@ -26,7 +26,7 @@ extern "C" {
 
 /** \file
 
-  Real and complex buffers
+  Complex buffers
 
   This file specifies the cvec_t buffer type, which is used throughout aubio to
   store complex data. Complex values are stored in terms of phase and
index e52fed819199df413abbce9588bfe4527a11d42a..b48dd7400fc57194bc8faaf80d14225c10643ceb 100644 (file)
@@ -28,8 +28,9 @@ extern "C" {
 
   Real buffers
 
-  This file specifies the lvec_t buffer type, which is used in aubio to
-  store double precision real data.
+  This file specifies the lvec_t buffer type, which is used in aubio to store
+  double precision real data. Note that the lvec_t data type is mostly used for
+  IIR filters (see temporal/filter.h).
 
 */