From: Paul Brossier <piem@piem.org>
Date: Tue, 28 Feb 2017 09:57:54 +0000 (+0100)
Subject: src/tempo/tempo.h: improve documentation (#22)
X-Git-Tag: 0.4.5~71
X-Git-Url: https://git.aubio.org/?a=commitdiff_plain;h=72af472e132e08a5cd1fd8bb1b7ce1f3561960e2;p=aubio.git

src/tempo/tempo.h: improve documentation (#22)
---

diff --git a/src/tempo/tempo.h b/src/tempo/tempo.h
index 13637f94..e2afe99c 100644
--- a/src/tempo/tempo.h
+++ b/src/tempo/tempo.h
@@ -154,8 +154,8 @@ smpl_t aubio_tempo_get_bpm(aubio_tempo_t * o);
 
   \param o beat tracking object
 
-  \return confidence with which the tempo has been observed, `0` if no
-  consistent value is found.
+  \return confidence with which the tempo has been observed, the higher the
+  more confidence, `0` if no consistent value is found.
 
 */
 smpl_t aubio_tempo_get_confidence(aubio_tempo_t * o);