Changeset 69b11d8 for src/onset

Timestamp:

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

Location:

src/onset

Files:

• onset.h (modified) (1 diff)
• peakpicker.h (modified) (1 diff)

src/onset/onset.h

@@ -21 +21 @@
 /** \file
  
-  Onset detection driver
+  Onset detection object
 
   The following routines compute the onset detection function and detect peaks
   in these functions. When onsets are found above a given silence threshold,
   and after a minimum inter-onset interval, the output vector returned by
-  aubio_onset_do is filled with 1. Otherwise, the output vector remains 0.
+  ::aubio_onset_do is filled with `1`. Otherwise, the output vector remains
+  `0`.
 
   The peak-picking threshold, the silence threshold, and the minimum
   inter-onset interval can be adjusted during the execution of the
   aubio_onset_do routine using the corresponding functions.
+
+  \example onset/test-onset.c
 
 */

src/onset/peakpicker.h

@@ -22 +22 @@
  
   Peak picking utilities function
+
+  \example onset/test-peakpicker.c
   
 */