Changeset 621f1ff

Timestamp:

Mar 2, 2013, 8:15:57 PM (12 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:

867084e

Parents:

b3ab675

Message:

src/: improve documentation

Location:

src

Files:

• cvec.h (modified) (3 diffs)
• temporal/a_weighting.h (modified) (1 diff)
• temporal/c_weighting.h (modified) (1 diff)
• temporal/filter.h (modified) (1 diff)
• vecutils.h (modified) (1 diff)

src/cvec.h

@@ -28 +28 @@
 /** \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
 
 */
@@ -38 +40 @@
 /** 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;
 
@@ -48 +50 @@
   [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.
 

src/temporal/a_weighting.h

@@ -53 +53 @@
   file sampling rates have been included for completeness.
 
+  \example temporal/test-a_weighting.c
+
 */
 

src/temporal/c_weighting.h

@@ -53 +53 @@
   file sampling rates have been included for completeness.
 
+  \example temporal/test-c_weighting.c
+
 */
 

src/temporal/filter.h

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

src/vecutils.h

@@ -19 +19 @@
 */
 
-/** @file
- *  various utilities functions for fvec and cvec objects
- *
+/** \file
+
+  Utility functions for ::fvec_t and ::cvec_t objects
+
  */