From: Paul Brossier <piem@piem.org>
Date: Sun, 3 Mar 2013 03:51:48 +0000 (-0500)
Subject: src/pitch/pitch.c: improve documentation
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=a64ef1d498caee547755f5a7602d950e3f5842ec;p=aubio.git

src/pitch/pitch.c: improve documentation
---

diff --git a/src/pitch/pitch.c b/src/pitch/pitch.c
index c5683831..f7c1fce4 100644
--- a/src/pitch/pitch.c
+++ b/src/pitch/pitch.c
@@ -34,18 +34,19 @@
 #include "pitch/pitchyinfft.h"
 #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
 {
   aubio_pitchm_freq,   /**< Frequency (Hz) */