diff CollidoscopeApp/include/Chunk.h @ 16:4dad0b810f18

Comment tidy up + attributions
author Fiore Martin <f.martin@qmul.ac.uk>
date Tue, 16 Aug 2016 14:27:53 +0100
parents 75b744078d66
children
line wrap: on
line diff
--- a/CollidoscopeApp/include/Chunk.h	Mon Aug 15 17:00:22 2016 +0100
+++ b/CollidoscopeApp/include/Chunk.h	Tue Aug 16 14:27:53 2016 +0100
@@ -33,7 +33,7 @@
  *
  * A chunk of audio in Collidoscope low-fi visual wave. 
  *
- * The visual wave of Collidoscope is made out of a number of bars that mimics in a low-fi fashion the typical waveform based representation of audio.
+ * The visual wave of Collidoscope is made out of a number of bars that mimic, in a low-fi fashion, the typical waveform-based representation of audio.
  * A Chunk is one of the bars of the visual wave. 
  *
  */
@@ -47,7 +47,7 @@
     const static float kHalfWidth;
 
     /**
-     * Constructor, takes as argument the index of this chunk in the wave
+     * Constructor, takes as argument the index of this chunk in the wave that contains it
      */ 
     Chunk( size_t index );
 
@@ -69,7 +69,7 @@
     float inline getBottom() const { return mAudioBottom; }
 
     /**
-     * Reset this chunks. When a chunk is reset it starts shrinking until it disappears.
+     * Reset this chunks. When a chunk is reset, it starts shrinking until it disappears or setTop/setBottom are called again
      *
      */ 
     void reset(){