Merge pull request #732 from marcelblum/docs-fix3

adding @category definitions for docs, fixing some typos/mistakes alo…

Tone/component/channel/MidSideMerge.ts

@@ -9,11 +9,12 @@ import { optionsFromArguments } from "../../core/util/Defaults";
 export type MidSideMergeOptions = ToneAudioNodeOptions;
 
 /**
- * MidSideMerge merges the mid and side signal after they've been separated by [[MidSideMerge]]
+ * MidSideMerge merges the mid and side signal after they've been separated by [[MidSideSplit]]
  * ```
  * Mid = (Left+Right)/sqrt(2);   // obtain mid-signal from left and right
- * Side = (Left-Right)/sqrt(2);   // obtain side-signal from left and righ
+ * Side = (Left-Right)/sqrt(2);   // obtain side-signal from left and right
  * ```
+ * @category Component
  */
 export class MidSideMerge extends ToneAudioNode<MidSideMergeOptions> {
 	

Tone/component/channel/MidSideSplit.ts

@@ -14,6 +14,7 @@ export type MidSideSplitOptions = ToneAudioNodeOptions;
  * Mid = (Left+Right)/sqrt(2);   // obtain mid-signal from left and right
  * Side = (Left-Right)/sqrt(2);   // obtain side-signal from left and right
  * ```
+ * @category Component
  */
 export class MidSideSplit extends ToneAudioNode<MidSideSplitOptions> {
 	

Tone/component/channel/Recorder.ts

@@ -34,6 +34,7 @@ export interface RecorderOptions extends ToneAudioNodeOptions {
  * 	anchor.href = url;
  * 	anchor.click();
  * }, 4000);
+ * @category Component
  */
 export class Recorder extends ToneAudioNode<RecorderOptions> {
 

Tone/component/dynamics/Gate.ts

@@ -21,6 +21,7 @@ export interface GateOptions extends ToneAudioNodeOptions {
  * const mic = new Tone.UserMedia().connect(gate);
  * // the gate will only pass through the incoming
  * // signal when it's louder than -30db
+ * @category Component
  */
 export class Gate extends ToneAudioNode<GateOptions> {
 

Tone/component/dynamics/Limiter.ts

@@ -21,6 +21,7 @@ export interface LimiterOptions extends ToneAudioNodeOptions {
  * const limiter = new Tone.Limiter(-20).toDestination();
  * const oscillator = new Tone.Oscillator().connect(limiter);
  * oscillator.start();
+ * @category Component
  */
 export class Limiter extends ToneAudioNode<LimiterOptions> {
 

Tone/component/dynamics/MidSideCompressor.ts

@@ -13,6 +13,7 @@ export interface MidSideCompressorOptions extends ToneAudioNodeOptions {
 /**
  * MidSideCompressor applies two different compressors to the [[mid]]
  * and [[side]] signal components of the input. See [[MidSideSplit]] and [[MidSideMerge]].
+ * @category Component
  */
 export class MidSideCompressor extends ToneAudioNode<MidSideCompressorOptions> {
 

Tone/component/dynamics/MultibandCompressor.ts

@@ -26,6 +26,7 @@ export interface MultibandCompressorOptions extends ToneAudioNodeOptions {
  * 		threshold: -12
  * 	}
  * });
+ * @category Component
  */
 export class MultibandCompressor extends ToneAudioNode<MultibandCompressorOptions> {
 

Tone/component/envelope/FrequencyEnvelope.ts

@@ -23,6 +23,7 @@ export interface FrequencyEnvelopeOptions extends EnvelopeOptions {
  * });
  * freqEnv.connect(oscillator.frequency);
  * freqEnv.triggerAttack();
+ * @category Component
  */
 export class FrequencyEnvelope extends Envelope {
 

Tone/core/Tone.ts

@@ -17,6 +17,7 @@ export interface BaseToneOptions { }
 
 /**
  * @class  Tone is the base class of all other classes.
+ * @category Core
  * @constructor
  */
 export abstract class Tone {

Tone/core/context/Param.ts

@@ -46,6 +46,7 @@ export type AutomationEvent = NormalAutomationEvent | TargetAutomationEvent;
  * additional unit conversion functionality. It also
  * serves as a base-class for classes which have a single,
  * automatable parameter.
+ * @category Core
  */
 export class Param<TypeName extends UnitName = "number">
 	extends ToneWithContext<ParamOptions<TypeName>>

Tone/core/util/Emitter.ts

@@ -10,6 +10,7 @@ export interface EmitterEventObject {
  * the ability to listen for and emit events.
  * Inspiration and reference from Jerome Etienne's [MicroEvent](https://github.com/jeromeetienne/microevent.js).
  * MIT (c) 2011 Jerome Etienne.
+ * @category Core
  */
 export class Emitter<EventType extends string = string> extends Tone {
 

Tone/effect/MidSideEffect.ts

@@ -13,6 +13,7 @@ export type MidSideEffectOptions = EffectOptions;
  * Applies a Mid/Side seperation and recombination.
  * Algorithm found in [kvraudio forums](http://www.kvraudio.com/forum/viewtopic.php?t=212587).
  * This is a base-class for Mid/Side Effects.
+ * @category Effect
  */
 export abstract class MidSideEffect<Options extends MidSideEffectOptions> extends Effect<Options> {
 

Tone/effect/StereoFeedbackEffect.ts

@@ -11,17 +11,7 @@ export interface StereoFeedbackEffectOptions extends StereoEffectOptions {
 }
 
 /**
- * Just like a stereo feedback effect, but the feedback is routed from left to right
- * and right to left instead of on the same channel.
- * ```
- * +--------------------------------+ feedbackL <-----------------------------------+
- * |                                                                                |
- * +-->                          +----->        +---->                          +---+
- *      feedbackMerge +--> split        (EFFECT)       merge +--> feedbackSplit
- * +-->                          +----->        +---->                          +---+
- * |                                                                                |
- * +--------------------------------+ feedbackR <-----------------------------------+
- * ```
+ * Base class for stereo feedback effects where the effectReturn is fed back into the same channel.
  */
 export class StereoFeedbackEffect<Options extends StereoFeedbackEffectOptions> extends StereoEffect<Options> {
 	

Tone/effect/StereoXFeedbackEffect.ts

@@ -18,6 +18,7 @@ export interface StereoXFeedbackEffectOptions extends StereoFeedbackEffectOption
  * |                                                                                  |
  * +--------------------------------+ feedbackR <-------------------------------------+
  * ```
+ * @category Effect
  */
 export class StereoXFeedbackEffect<Options extends StereoXFeedbackEffectOptions> extends StereoFeedbackEffect<Options> {
 	

Tone/signal/GreaterThan.ts

@@ -17,6 +17,7 @@ export type GreaterThanOptions = SignalOptions<"number">;
  * 	const gt = new Tone.GreaterThan(2).toDestination();
  * 	const sig = new Tone.Signal(4).connect(gt);
  * }, 0.1, 1);
+ * @category Signal
  */
 export class GreaterThan extends Signal<"number"> {
 

Tone/signal/GreaterThanZero.ts

@@ -14,6 +14,7 @@ export type GreaterThanZeroOptions = SignalOperatorOptions
  * 	const sig = new Tone.Signal(0.5).connect(gt0);
  * 	sig.setValueAtTime(-1, 0.05);
  * }, 0.1, 1);
+ * @category Signal
  */
 export class GreaterThanZero extends SignalOperator<GreaterThanZeroOptions> {
 

Tone/signal/ScaleExp.ts

@@ -14,6 +14,7 @@ export interface ScaleExpOptions extends ScaleOptions {
  * @example
  * const scaleExp = new Tone.ScaleExp(0, 100, 2);
  * const signal = new Tone.Signal(0.5).connect(scaleExp);
+ * @category Signal
  */
 export class ScaleExp extends Scale<ScaleExpOptions> {