src/tempo/tempo.h: improve documentation (#22)
authorPaul Brossier <piem@piem.org>
Tue, 28 Feb 2017 09:57:54 +0000 (10:57 +0100)
committerPaul Brossier <piem@piem.org>
Tue, 28 Feb 2017 09:57:54 +0000 (10:57 +0100)
src/tempo/tempo.h

index 13637f9..e2afe99 100644 (file)
@@ -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);