diff --git a/Tone/core/context/Context.ts b/Tone/core/context/Context.ts index 1446bfa7..c653a779 100644 --- a/Tone/core/context/Context.ts +++ b/Tone/core/context/Context.ts @@ -437,7 +437,7 @@ export class Context extends BaseContext { /** * Starts the audio context from a suspended state. This is required - * to initially start the AudioContext. + * to initially start the AudioContext. See [[Tone.start]] */ resume(): Promise { if (this._context.state === "suspended" && isAudioContext(this._context)) { @@ -448,8 +448,8 @@ export class Context extends BaseContext { } /** - * Promise which is invoked when the context is running. - * Tries to resume the context if it's not started. + * Close the context. Once closed, the context can no longer be used and + * any AudioNodes created from the context will be silent. */ async close(): Promise { if (isAudioContext(this._context)) { @@ -461,7 +461,7 @@ export class Context extends BaseContext { } /** - * Generate a looped buffer at some constant value. + * **Internal** Generate a looped buffer at some constant value. */ getConstant(val: number): AudioBufferSourceNode { if (this._constants.has(val)) { diff --git a/Tone/instrument/Synth.ts b/Tone/instrument/Synth.ts index 9b8d730b..adff154c 100644 --- a/Tone/instrument/Synth.ts +++ b/Tone/instrument/Synth.ts @@ -17,7 +17,7 @@ export interface SynthOptions extends MonophonicOptions { } /** - * Synth is composed simply of a {@link OmniOscillator} routed through an {@link AmplitudeEnvelope}. + * Synth is composed simply of a [[OmniOscillator]] routed through an [[AmplitudeEnvelope]]. * ``` * +----------------+ +-------------------+ * | OmniOscillator +>--> AmplitudeEnvelope +>--> Output diff --git a/Tone/signal/AudioToGain.ts b/Tone/signal/AudioToGain.ts index f4c27204..8c515ee3 100644 --- a/Tone/signal/AudioToGain.ts +++ b/Tone/signal/AudioToGain.ts @@ -4,7 +4,7 @@ import { WaveShaper } from "./WaveShaper"; /** * AudioToGain converts an input in AudioRange [-1,1] to NormalRange [0,1]. - * See {@link GainToAudio}. + * See [[GainToAudio]]. * @category Signal */ export class AudioToGain extends SignalOperator { diff --git a/Tone/signal/GainToAudio.ts b/Tone/signal/GainToAudio.ts index a3304621..3aacdad1 100644 --- a/Tone/signal/GainToAudio.ts +++ b/Tone/signal/GainToAudio.ts @@ -4,7 +4,7 @@ import { WaveShaper } from "./WaveShaper"; /** * GainToAudio converts an input in NormalRange [0,1] to AudioRange [-1,1]. - * See {@link AudioToGain}. + * See [[AudioToGain]]. * @category Signal */ export class GainToAudio extends SignalOperator { diff --git a/Tone/signal/Multiply.ts b/Tone/signal/Multiply.ts index 9b22b423..0dc4bce9 100644 --- a/Tone/signal/Multiply.ts +++ b/Tone/signal/Multiply.ts @@ -43,7 +43,7 @@ export class Multiply extends input: InputNode; /** - * The product of the input and {@link factor} + * The product of the input and [[factor]] */ output: OutputNode;