From 621f1ff6aed41ad258484d939eff9d97a0e25c5e Mon Sep 17 00:00:00 2001
From: Paul Brossier <piem@piem.org>
Date: Sat, 2 Mar 2013 14:15:57 -0500
Subject: [PATCH] src/: improve documentation

---
 src/cvec.h                 | 18 ++++++++++--------
 src/temporal/a_weighting.h |  2 ++
 src/temporal/c_weighting.h |  2 ++
 src/temporal/filter.h      |  2 ++
 src/vecutils.h             |  7 ++++---
 5 files changed, 20 insertions(+), 11 deletions(-)

diff --git a/src/cvec.h b/src/cvec.h
index 4dc307c2..aeff6e01 100644
--- a/src/cvec.h
+++ b/src/cvec.h
@@ -27,19 +27,21 @@ extern "C" {
 
 /** \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 @@ typedef struct {
   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
diff --git a/src/temporal/a_weighting.h b/src/temporal/a_weighting.h
index cf1a1cbf..e5f743d0 100644
--- 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
diff --git a/src/temporal/c_weighting.h b/src/temporal/c_weighting.h
index c80cfc37..5e33b6c3 100644
--- 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
diff --git a/src/temporal/filter.h b/src/temporal/filter.h
index 5d151fff..83d2e78c 100644
--- 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
  
 */
 
diff --git a/src/vecutils.h b/src/vecutils.h
index 37857130..9bbdb48f 100644
--- 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
-- 
2.26.2