From: Paul Brossier <piem@piem.org>
Date: Sat, 7 Dec 2013 16:40:07 +0000 (-0500)
Subject: src/synth/wavetable.h: improve documentation
X-Git-Tag: 0.4.0-beta1~41
X-Git-Url: https://git.aubio.org/?a=commitdiff_plain;h=8750bbd4ed5a46cd69c1ed5e1112da2c6b4048ca;p=aubio.git

src/synth/wavetable.h: improve documentation
---

diff --git a/src/synth/wavetable.h b/src/synth/wavetable.h
index aaf2a2e0..89837245 100644
--- a/src/synth/wavetable.h
+++ b/src/synth/wavetable.h
@@ -110,17 +110,15 @@ uint_t aubio_wavetable_set_playing ( aubio_wavetable_t * o, uint_t playing );
 /** 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
 
 */
 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 @@ uint_t aubio_wavetable_stop ( aubio_wavetable_t * o );
 /** 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 @@ smpl_t aubio_wavetable_get_freq ( aubio_wavetable_t * o);
 /** 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