Changeset 4b7a740


Ignore:
Timestamp:
Dec 7, 2013, 5:58:30 PM (7 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master, pitchshift, sampler, timestretch, yinfft+
Children:
2b6139e7
Parents:
5899752
Message:

src/pitch/pitch.h: improve documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/pitch/pitch.h

    r5899752 r4b7a740  
    8080  \param mode set pitch units for output
    8181
     82  \return 0 if successfull, non-zero otherwise
     83
    8284*/
    8385uint_t aubio_pitch_set_unit (aubio_pitch_t * o, char_t * mode);
     
    8890  \param silence level threshold under which pitch should be ignored, in dB
    8991
     92  \return 0 if successfull, non-zero otherwise
     93
    9094*/
    9195uint_t aubio_pitch_set_silence (aubio_pitch_t * o, smpl_t silence);
     
    9397/** set the silence threshold of the pitch detection object
    9498
    95   \param o pitch detection object as returned by new_aubio_pitch()
     99  \param o pitch detection object as returned by ::new_aubio_pitch()
    96100
    97   \param return level threshold under which pitch should be ignored, in dB
     101  \return level threshold under which pitch should be ignored, in dB
    98102
    99103*/
     
    103107
    104108  \param o pitch detection object as returned by new_aubio_pitch()
     109
    105110  \return the current confidence of the pitch algorithm
    106 
    107 The confidence
    108111
    109112*/
Note: See TracChangeset for help on using the changeset viewer.