Changeset 4b7a740 for src

Timestamp:

Dec 7, 2013, 5:58:30 PM (11 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, pitchshift, sampler, timestretch, yinfft+

Children:

2b6139e7

Parents:

5899752

Message:

src/pitch/pitch.h: improve documentation

File:

• src/pitch/pitch.h (modified) (4 diffs)

src/pitch/pitch.h

@@ -80 +80 @@
   \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);
@@ -88 +90 @@
   \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);
@@ -93 +97 @@
 /** 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
 
 */
@@ -103 +107 @@
 
   \param o pitch detection object as returned by new_aubio_pitch()
+
   \return the current confidence of the pitch algorithm
-
-The confidence
 
 */