Changeset a64ef1d for src/pitch

Timestamp:

Mar 3, 2013, 4:51:48 AM (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:

b8c0685

Parents:

33cd81f

Message:

src/pitch/pitch.c: improve documentation

File:

• src/pitch/pitch.c (modified) (1 diff)

src/pitch/pitch.c

@@ -35 +35 @@
 #include "pitch/pitch.h"
 
-/** pitch detection algorithm */
+/** pitch detection algorithms */
 typedef enum
 {
-  aubio_pitcht_yin,     /**< YIN algorithm */
-  aubio_pitcht_mcomb,   /**< Multi-comb filter */
-  aubio_pitcht_schmitt, /**< Schmitt trigger */
-  aubio_pitcht_fcomb,   /**< Fast comb filter */
-  aubio_pitcht_yinfft,   /**< Spectral YIN */
-  aubio_pitcht_default = aubio_pitcht_yinfft, /**< the one used when "default" is asked */
+  aubio_pitcht_yin,        /**< `yin`, YIN algorithm */
+  aubio_pitcht_mcomb,      /**< `mcomb`, Multi-comb filter */
+  aubio_pitcht_schmitt,    /**< `schmitt`, Schmitt trigger */
+  aubio_pitcht_fcomb,      /**< `fcomb`, Fast comb filter */
+  aubio_pitcht_yinfft,     /**< `yinfft`, Spectral YIN */
+  aubio_pitcht_default
+    = aubio_pitcht_yinfft, /**< `default` */
 } aubio_pitch_type;
 
-/** pitch detection output mode */
+/** pitch detection output modes */
 typedef enum
 {