From 4b7a740dec88b19e245276b47261db6ade864be4 Mon Sep 17 00:00:00 2001 From: Paul Brossier Date: Sat, 7 Dec 2013 11:58:30 -0500 Subject: [PATCH] src/pitch/pitch.h: improve documentation --- src/pitch/pitch.h | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/src/pitch/pitch.h b/src/pitch/pitch.h index 82c26fb0..d9b99bb8 100644 --- a/src/pitch/pitch.h +++ b/src/pitch/pitch.h @@ -79,6 +79,8 @@ aubio_pitch_t *new_aubio_pitch (char_t * method, \param o pitch detection object as returned by new_aubio_pitch() \param mode set pitch units for output + \return 0 if successfull, non-zero otherwise + */ uint_t aubio_pitch_set_unit (aubio_pitch_t * o, char_t * mode); @@ -87,14 +89,16 @@ uint_t aubio_pitch_set_unit (aubio_pitch_t * o, char_t * mode); \param o pitch detection object as returned by new_aubio_pitch() \param silence level threshold under which pitch should be ignored, in dB + \return 0 if successfull, non-zero otherwise + */ uint_t aubio_pitch_set_silence (aubio_pitch_t * o, smpl_t silence); /** set the silence threshold of the pitch detection object - \param o pitch detection object as returned by new_aubio_pitch() + \param o pitch detection object as returned by ::new_aubio_pitch() - \param return level threshold under which pitch should be ignored, in dB + \return level threshold under which pitch should be ignored, in dB */ smpl_t aubio_pitch_get_silence (aubio_pitch_t * o); @@ -102,9 +106,8 @@ smpl_t aubio_pitch_get_silence (aubio_pitch_t * o); /** get the current confidence \param o pitch detection object as returned by new_aubio_pitch() - \return the current confidence of the pitch algorithm -The confidence + \return the current confidence of the pitch algorithm */ smpl_t aubio_pitch_get_confidence (aubio_pitch_t * o); -- 2.11.0