updating doc links

This commit is contained in:
Yotam Mann 2020-05-18 21:13:22 -04:00
parent 510a08df4e
commit 23af858ef2
5 changed files with 8 additions and 8 deletions

View file

@ -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<void> {
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<void> {
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)) {

View file

@ -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

View file

@ -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<ToneAudioNodeOptions> {

View file

@ -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<ToneAudioNodeOptions> {

View file

@ -43,7 +43,7 @@ export class Multiply<TypeName extends "number" | "positive" = "number"> extends
input: InputNode;
/**
* The product of the input and {@link factor}
* The product of the input and [[factor]]
*/
output: OutputNode;