shithub: aubio

Download patch

ref: 8750bbd4ed5a46cd69c1ed5e1112da2c6b4048ca
parent: 912f34351fac4f86df253047a21b909e5baff795
author: Paul Brossier <piem@piem.org>
date: Sat Dec 7 06:40:07 EST 2013

src/synth/wavetable.h: improve documentation

--- a/src/synth/wavetable.h
+++ b/src/synth/wavetable.h
@@ -110,7 +110,6 @@
 /** play sample from start
 
   \param o wavetable, created by ::new_aubio_wavetable
-  \param playing 0 for not playing, 1 for playing
 
   \return 0 if successful, 1 otherwise
 
@@ -117,10 +116,9 @@
 */
 uint_t aubio_wavetable_play ( aubio_wavetable_t * o );
 
-/** stop sample from start
+/** stop sample
 
   \param o wavetable, created by ::new_aubio_wavetable
-  \param playing 0 for not playing, 1 for playing
 
   \return 0 if successful, 1 otherwise
 
@@ -130,7 +128,7 @@
 /** set wavetable frequency
 
   \param o wavetable, created by ::new_aubio_wavetable
-  \param playing 0 for not playing, 1 for playing
+  \param freq new frequency value for the wavetable
 
   \return 0 if successful, 1 otherwise
 
@@ -149,7 +147,7 @@
 /** set wavetable amplitude
 
   \param o wavetable, created by ::new_aubio_wavetable
-  \param playing 0 for not playing, 1 for playing
+  \param amp new amplitude value for the wavetable
 
   \return 0 if successful, 1 otherwise
 
--