ref: 621f1ff6aed41ad258484d939eff9d97a0e25c5e
parent: b3ab6756c300d5df5bacabd3193478ff69bd391d
author: Paul Brossier <piem@piem.org>
date: Sat Mar 2 09:15:57 EST 2013
src/: improve documentation
--- a/src/cvec.h
+++ b/src/cvec.h
@@ -27,19 +27,21 @@
/** \file
- Complex buffers
+ Vector of complex-valued data
- 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
- norm, within size/2+1 long vectors.
+ This file specifies the ::cvec_t buffer type, which is used throughout aubio
+ to store complex data. Complex values are stored in terms of ::cvec_t.phas
+ and norm, within size/2+1 long vectors of ::smpl_t.
+ \example test-cvec.c
+
*/
/** Buffer for complex data */
typedef struct {- uint_t length; /**< length of buffer = (requested length)/2 + 1 */
- smpl_t *norm; /**< norm array of size [length] */
- smpl_t *phas; /**< phase array of size [length] */
+ uint_t length; /**< length of buffer = (requested length)/2 + 1 */
+ smpl_t *norm; /**< norm array of size ::cvec_t.length */
+ smpl_t *phas; /**< phase array of size ::cvec_t.length */
} cvec_t;
/** cvec_t buffer creation function
@@ -47,7 +49,7 @@
This function creates a cvec_t structure holding two arrays of size
[length/2+1], corresponding to the norm and phase values of the
spectral frame. The length stored in the structure is the actual size of both
- arrays, not the length of the complex and symetrical vector, specified as
+ arrays, not the length of the complex and symmetrical vector, specified as
creation argument.
\param length the length of the buffer to create
--- a/src/temporal/a_weighting.h
+++ b/src/temporal/a_weighting.h
@@ -52,6 +52,8 @@
The sampling frequency should normally be higher than 20kHz, but most common
file sampling rates have been included for completeness.
+ \example temporal/test-a_weighting.c
+
*/
#ifdef __cplusplus
--- a/src/temporal/c_weighting.h
+++ b/src/temporal/c_weighting.h
@@ -52,6 +52,8 @@
The sampling frequency should normally be higher than 20kHz, but most common
file sampling rates have been included for completeness.
+ \example temporal/test-c_weighting.c
+
*/
#ifdef __cplusplus
--- a/src/temporal/filter.h
+++ b/src/temporal/filter.h
@@ -57,6 +57,8 @@
- 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().
+
+ \example temporal/test-filter.c
*/
--- a/src/vecutils.h
+++ b/src/vecutils.h
@@ -18,9 +18,10 @@
*/
-/** @file
- * various utilities functions for fvec and cvec objects
- *
+/** \file
+
+ Utility functions for ::fvec_t and ::cvec_t objects
+
*/
#ifndef _VECUTILS_H