Mirrors/Tone.js
2
0
Fork 0
mirror of https://github.com/Tonejs/Tone.js synced 2024-11-16 08:38:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

jsdoc'ing

Browse source
This commit is contained in:
Yotam Mann 2014-12-03 21:38:24 -05:00
parent da014bf954
commit cd31d02048
4 changed files with 19 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
Tone/instrument/AMSynth.js
View file

@ -5,7 +5,8 @@ function(Tone){
"use strict";
/**
* @class the AMSynth is composed of two MonoSynths where one MonoSynth is the
* @class the AMSynth is an amplitude modulation synthesizer
* composed of two MonoSynths where one MonoSynth is the
* carrier and the second is the modulator.
*
* @constructor

2
Tone/instrument/DuoSynth.js
View file

@ -56,7 +56,7 @@ function(Tone){
this._vibratoDelay = this.toSeconds(options.vibratoDelay);
/**
* the amount before the vibrato starts
* the amount of vibrato
* @type {number}
* @private
*/

12
Tone/instrument/MonoSynth.js
View file

@ -6,7 +6,17 @@ function(Tone){
/**
* @class the MonoSynth is a single oscillator, monophonic synthesizer
* with a filter, and two envelopes (on the filter and the amplitude)
* with a filter, and two envelopes (on the filter and the amplitude).
*
* Flow:
*
* <pre>
* OmniOscillator+-->AmplitudeEnvelope+-->Filter 
*                             ^    
*                             |    
*            ScaledEnvelope+--+
* </pre>
*
*
* @constructor
* @extends {Tone.Monophonic}

10
Tone/source/OmniOscillator.js
View file

@ -4,7 +4,9 @@ function(Tone){
"use strict";
/**
* @class An OmniOscillator can be a sine|square|triangle|sawtooth|pulse|pwm
* @class OmniOscillator aggregates Tone.Oscillator, Tone.PulseOscillator,
* and Tone.PWMOscillator which allows it to have the types:
* sine, square, triangle, sawtooth, pulse or pwm.
*
* @extends {Tone.Oscillator}
* @constructor
@ -17,14 +19,12 @@ function(Tone){
/**
* the frequency control
* (doesn't do anything for noises)
* @type {Tone.Signal}
*/
this.frequency = new Tone.Signal(options.frequency);
/**
* the detune control
* (doesn't do anything for noises)
* @type {Tone.Signal}
*/
this.detune = new Tone.Signal(options.detune);
@ -212,10 +212,10 @@ function(Tone){
Tone.OmniOscillator.prototype.dispose = function(){
Tone.Source.prototype.dispose.call(this);
this.detune.dispose();
this.frequency.dispose();
this._oscillator.dispose();
this.detune = null;
this.frequency.dispose();
this.frequency = null;
this._oscillator.dispose();
this._oscillator = null;
this._sourceType = null;
};