diff CollidoscopeApp/include/EnvASR.h @ 2:dd889fff8423

added some comments

--- a/CollidoscopeApp/include/EnvASR.h	Fri Jul 08 11:39:18 2016 +0200
+++ b/CollidoscopeApp/include/EnvASR.h	Mon Jul 11 17:03:40 2016 +0200
@@ -2,6 +2,16 @@
 
 namespace collidoscope {
 
+
+/* 
+ * An ASR envelope with linear shape. It is modeled after the STK envelope classes.
+ * The tick() method advances the computation of the envelope one sample and returns the computed sample
+ * The class is templated for the type of the samples that each tick of the envelope produces. 
+ *
+ * Client classes can set/get the current state of the envelope with the
+ * respective getter/setter methods
+ *
+ */
 template <typename T>
 class EnvASR
 {
@@ -88,4 +98,4 @@
 };
 
 
-}
\ No newline at end of file
+}