better type and JS docs, see #161

phetsims · May 18, 2022 · ddc4867 · ddc4867
1 parent 3021b2f
commit ddc4867
Show file tree

Hide file tree

Showing 4 changed files with 1 addition and 5 deletions.
diff --git a/js/SoundUtils.ts b/js/SoundUtils.ts
@@ -107,7 +107,6 @@ const findSoundStartIndex = ( soundData: Float32Array, length: number, threshold
  * @param soundData - the sample values for the sound
  * @param length - length of the sound data
  * @param threshold - detection level for the presence of sound, should be between 0 and 1
- * @returns {number} - index where sound ends
  */
 const findSoundEndIndex = ( soundData: Float32Array, length: number, threshold: number ): number => {
 

diff --git a/js/sound-generators/NoiseGenerator.ts b/js/sound-generators/NoiseGenerator.ts
@@ -279,7 +279,7 @@ class NoiseGenerator extends SoundGenerator {
 
   /**
    * Stop the noise source.
-   * @param {number} [time] - optional audio context time at which this should be stopped
+   * @param [time] - optional audio context time at which this should be stopped
    */
   public stop( time = 0 ): void {
 

diff --git a/js/sound-generators/PitchedPopGenerator.ts b/js/sound-generators/PitchedPopGenerator.ts
@@ -67,14 +67,12 @@ class PitchedPopGenerator extends SoundGenerator {
     this.soundSources = [];
     _.times( options.numPopGenerators, () => {
 
-      // {OscillatorNode}
       const oscillator = this.audioContext.createOscillator();
       const now = this.audioContext.currentTime;
       oscillator.type = 'sine';
       oscillator.frequency.setValueAtTime( options.pitchRange.min, now );
       oscillator.start( 0 );
 
-      // {GainNode}
       const gainNode = this.audioContext.createGain();
       gainNode.gain.setValueAtTime( 0, now );
       oscillator.connect( gainNode );

diff --git a/js/sound-generators/SoundClip.ts b/js/sound-generators/SoundClip.ts
@@ -294,7 +294,6 @@ class SoundClip extends SoundGenerator {
 
   /**
    * ES5 getter for playback rate
-   * @returns {number}
    */
   public get playbackRate(): number {
     return this.getPlaybackRate();