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

Comment tidy up + attributions

 
 /**
  *
  * 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. 
  *
  */
 
 class Chunk

 
     const static float kWidth;
     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 );
 
     /**
      * Sets the top value of this chunk. The value is passed in audio coordinates : [-1.0, 1.0]

      * Get the bottom value of this chunk. The value is returned in audio coordinates : [-1.0, 1.0]
      */
     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(){
         mResetting = true;
     }