src/pitch/pitch.h: add basic description of unit modes
authorPaul Brossier <piem@piem.org>
Mon, 28 Nov 2016 16:32:17 +0000 (17:32 +0100)
committerPaul Brossier <piem@piem.org>
Mon, 28 Nov 2016 16:32:17 +0000 (17:32 +0100)
src/pitch/pitch.h

index 0f34c6c..253ee64 100644 (file)
@@ -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
 
 */