From: Paul Brossier <piem@piem.org>
Date: Mon, 28 Nov 2016 16:32:17 +0000 (+0100)
Subject: src/pitch/pitch.h: add basic description of unit modes
X-Git-Tag: 0.4.4~141
X-Git-Url: https://git.aubio.org/?a=commitdiff_plain;h=9ad0dcc8df728a6dd05ce650b23270737c3d1d65;p=aubio.git

src/pitch/pitch.h: add basic description of unit modes
---

diff --git a/src/pitch/pitch.h b/src/pitch/pitch.h
index 0f34c6c9..253ee648 100644
--- a/src/pitch/pitch.h
+++ b/src/pitch/pitch.h
@@ -150,6 +150,8 @@ aubio_pitch_t *new_aubio_pitch (const char_t * method,
   \param o pitch detection object as returned by new_aubio_pitch()
   \param mode set pitch units for output
 
+  mode can be one of "Hz", "midi", "cent", or "bin". Defaults to "Hz".
+
   \return 0 if successfull, non-zero otherwise
 
 */