Changeset 69b11d8 for src/pitch/pitchfcomb.h

Timestamp:

Mar 3, 2013, 4:44:18 AM (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:

b173ca1

Parents:

f72364d

Message:

src/*/*.h: add link to examples, remove trailing spaces, improve documentation

File:

• src/pitch/pitchfcomb.h (modified) (3 diffs)

src/pitch/pitchfcomb.h

@@ -28 +28 @@
    This file was derived from the tuneit project, written by Mario Lang to
    detect the fundamental frequency of a sound.
-   
-   see http://delysid.org/tuneit.html 
+
+   See http://delysid.org/tuneit.html
+
+   \example pitch/test-pitchfcomb.c
 
 */
@@ -43 +45 @@
 typedef struct _aubio_pitchfcomb_t aubio_pitchfcomb_t;
 
-/** execute pitch detection on an input buffer 
- 
+/** execute pitch detection on an input buffer
+
   \param p pitch detection object as returned by new_aubio_pitchfcomb
-  \param input input signal window (length as specified at creation time) 
+  \param input input signal window (length as specified at creation time)
   \param output pitch candidates in bins
- 
+
 */
 void aubio_pitchfcomb_do (aubio_pitchfcomb_t * p, fvec_t * input,
@@ -54 +56 @@
 
 /** creation of the pitch detection object
- 
-  \param buf_size size of the input buffer to analyse 
-  \param hop_size step size between two consecutive analysis instant 
- 
+
+  \param buf_size size of the input buffer to analyse
+  \param hop_size step size between two consecutive analysis instant
+
 */
 aubio_pitchfcomb_t *new_aubio_pitchfcomb (uint_t buf_size, uint_t hop_size);
 
 /** deletion of the pitch detection object
- 
+
   \param p pitch detection object as returned by new_aubio_pitchfcomb
- 
+
 */
 void del_aubio_pitchfcomb (aubio_pitchfcomb_t * p);