tone 14.9.11 → 14.9.13

package/Tone/component/analysis/Analyser.ts

@@ -92,8 +92,8 @@ export class Analyser extends ToneAudioNode<AnalyserOptions> {
 	}
 
 	/**
-	 * Run the analysis given the current settings. If [[channels]] = 1,
-	 * it will return a Float32Array. If [[channels]] > 1, it will
+	 * Run the analysis given the current settings. If {@link channels} = 1,
+	 * it will return a Float32Array. If {@link channels} > 1, it will
 	 * return an array of Float32Arrays where each index in the array
 	 * represents the analysis done on a channel.
 	 */
@@ -128,7 +128,7 @@ export class Analyser extends ToneAudioNode<AnalyserOptions> {
 
 	/**
 	 * The number of channels the analyser does the analysis on. Channel
-	 * separation is done using [[Split]]
+	 * separation is done using {@link Split}
 	 */
 	get channels(): number {
 		return this._analysers.length;

package/Tone/component/analysis/DCMeter.ts

@@ -4,7 +4,8 @@ import { MeterBase, MeterBaseOptions } from "./MeterBase";
 export type DCMeterOptions = MeterBaseOptions;
 
 /**
- * DCMeter gets the raw value of the input signal at the current time. See also {@link Meter}.
+ * DCMeter gets the raw value of the input signal at the current time. 
+ * @see {@link Meter}.
  *
  * @example
  * const meter = new Tone.DCMeter();

package/Tone/component/analysis/FFT.ts

@@ -51,7 +51,7 @@ export class FFT extends MeterBase<FFTOptions> {
 
 	/**
 	 * Gets the current frequency data from the connected audio source.
-	 * Returns the frequency data of length [[size]] as a Float32Array of decibel values.
+	 * Returns the frequency data of length {@link size} as a Float32Array of decibel values.
 	 */
 	getValue(): Float32Array {
 		const values = this._analyser.getValue() as Float32Array;
@@ -60,7 +60,7 @@ export class FFT extends MeterBase<FFTOptions> {
 
 	/**
 	 * The size of analysis. This must be a power of two in the range 16 to 16384.
-	 * Determines the size of the array returned by [[getValue]] (i.e. the number of
+	 * Determines the size of the array returned by {@link getValue} (i.e. the number of
 	 * frequency bins). Large FFT sizes may be costly to compute.
 	 */
 	get size(): PowerOfTwo {
@@ -81,7 +81,7 @@ export class FFT extends MeterBase<FFTOptions> {
 	}
 
 	/**
-	 * Returns the frequency value in hertz of each of the indices of the FFT's [[getValue]] response.
+	 * Returns the frequency value in hertz of each of the indices of the FFT's {@link getValue} response.
 	 * @example
 	 * const fft = new Tone.FFT(32);
 	 * console.log([0, 1, 2, 3, 4].map(index => fft.getFrequencyOfIndex(index)));

package/Tone/component/analysis/Meter.ts

@@ -16,7 +16,8 @@ export interface MeterOptions extends MeterBaseOptions {
  * of an input signal. It can also get the raw value of the input signal.
  * Setting `normalRange` to `true` will covert the output to a range of
  * 0-1. See an example using a graphical display 
- * [here](https://tonejs.github.io/examples/meter). See also {@link DCMeter}.
+ * [here](https://tonejs.github.io/examples/meter). 
+ * @see {@link DCMeter}.
  *
  * @example
  * const meter = new Tone.Meter();
@@ -80,7 +81,7 @@ export class Meter extends MeterBase<MeterOptions> {
 	}
 
 	/**
-	 * Use [[getValue]] instead. For the previous getValue behavior, use DCMeter.
+	 * Use {@link getValue} instead. For the previous getValue behavior, use DCMeter.
 	 * @deprecated
 	 */
 	getLevel(): number | number[] {
@@ -90,9 +91,9 @@ export class Meter extends MeterBase<MeterOptions> {
 
 	/**
 	 * Get the current value of the incoming signal. 
-	 * Output is in decibels when [[normalRange]] is `false`.
-	 * If [[channels]] = 1, then the output is a single number
-	 * representing the value of the input signal. When [[channels]] > 1,
+	 * Output is in decibels when {@link normalRange} is `false`.
+	 * If {@link channels} = 1, then the output is a single number
+	 * representing the value of the input signal. When {@link channels} > 1,
 	 * then each channel is returned as a value in a number array. 
 	 */
 	getValue(): number | number[] {

package/Tone/component/analysis/Waveform.ts

@@ -46,7 +46,7 @@ export class Waveform extends MeterBase<WaveformOptions> {
 
 	/**
 	 * The size of analysis. This must be a power of two in the range 16 to 16384.
-	 * Determines the size of the array returned by [[getValue]].
+	 * Determines the size of the array returned by {@link getValue}.
 	 */
 	get size(): PowerOfTwo {
 		return this._analyser.size;

package/Tone/component/channel/Channel.ts

@@ -17,7 +17,7 @@ export interface ChannelOptions extends ToneAudioNodeOptions {
 
 /**
  * Channel provides a channel strip interface with volume, pan, solo and mute controls. 
- * See [[PanVol]] and [[Solo]]
+ * @see {@link PanVol} and {@link Solo}
  * @example
  * // pan the incoming signal left and drop the volume 12db
  * const channel = new Tone.Channel(-0.25, -12);
@@ -91,7 +91,7 @@ export class Channel extends ToneAudioNode<ChannelOptions> {
 	}
 
 	/**
-	 * Solo/unsolo the channel. Soloing is only relative to other [[Channel]]s and [[Solo]] instances
+	 * Solo/unsolo the channel. Soloing is only relative to other {@link Channel}s and {@link Solo} instances
 	 */
 	get solo(): boolean {
 		return this._solo.solo;
@@ -137,9 +137,9 @@ export class Channel extends ToneAudioNode<ChannelOptions> {
 
 	/**
 	 * Send audio to another channel using a string. `send` is a lot like
-	 * [[connect]], except it uses a string instead of an object. This can 
-	 * be useful in large applications to decouple sections since [[send]]
-	 * and [[receive]] can be invoked separately in order to connect an object
+	 * {@link connect}, except it uses a string instead of an object. This can 
+	 * be useful in large applications to decouple sections since {@link send}
+	 * and {@link receive} can be invoked separately in order to connect an object
 	 * @param name The channel name to send the audio
 	 * @param volume The amount of the signal to send. 
 	 * 	Defaults to 0db, i.e. send the entire signal
@@ -158,7 +158,7 @@ export class Channel extends ToneAudioNode<ChannelOptions> {
 	}
 
 	/**
-	 * Receive audio from a channel which was connected with [[send]]. 
+	 * Receive audio from a channel which was connected with {@link send}. 
 	 * @param name The channel name to receive audio from.
 	 */
 	receive(name: string): this {

package/Tone/component/channel/MidSideMerge.ts

@@ -9,7 +9,7 @@ import { optionsFromArguments } from "../../core/util/Defaults";
 export type MidSideMergeOptions = ToneAudioNodeOptions;
 
 /**
- * MidSideMerge merges the mid and side signal after they've been separated by [[MidSideSplit]]
+ * MidSideMerge merges the mid and side signal after they've been separated by {@link MidSideSplit}
  * ```
  * Mid = (Left+Right)/sqrt(2);   // obtain mid-signal from left and right
  * Side = (Left-Right)/sqrt(2);   // obtain side-signal from left and right
@@ -21,7 +21,7 @@ export class MidSideMerge extends ToneAudioNode<MidSideMergeOptions> {
 	readonly name: string = "MidSideMerge";
 
 	/**
-	 * There is no input, connect sources to either [[mid]] or [[side]] inputs.
+	 * There is no input, connect sources to either {@link mid} or {@link side} inputs.
 	 */
 	readonly input: undefined;
 

package/Tone/component/channel/MidSideSplit.ts

@@ -23,7 +23,7 @@ export class MidSideSplit extends ToneAudioNode<MidSideSplitOptions> {
 	readonly input: Split;
 
 	/**
-	 * There is no output node, use either [[mid]] or [[side]] outputs.
+	 * There is no output node, use either {@link mid} or {@link side} outputs.
 	 */
 	readonly output: undefined;
 	/**

package/Tone/component/channel/Recorder.ts

@@ -127,7 +127,7 @@ export class Recorder extends ToneAudioNode<RecorderOptions> {
 
 	/**
 	 * Stop the recorder. Returns a promise with the recorded content until this point
-	 * encoded as [[mimeType]]
+	 * encoded as {@link mimeType}
 	 */
 	async stop(): Promise<Blob> {
 		assert(this.state !== "stopped", "Recorder is not started");

package/Tone/component/dynamics/Gate.ts

@@ -13,8 +13,8 @@ export interface GateOptions extends ToneAudioNodeOptions {
 
 /**
  * Gate only passes a signal through when the incoming
- * signal exceeds a specified threshold. It uses [[Follower]] to follow the ampltiude
- * of the incoming signal and compares it to the [[threshold]] value using [[GreaterThan]].
+ * signal exceeds a specified threshold. It uses {@link Follower} to follow the ampltiude
+ * of the incoming signal and compares it to the {@link threshold} value using {@link GreaterThan}.
  *
  * @example
  * const gate = new Tone.Gate(-30, 0.2).toDestination();
@@ -90,7 +90,8 @@ export class Gate extends ToneAudioNode<GateOptions> {
 	}
 
 	/**
-	 * The attack/decay speed of the gate. See [[Follower.smoothing]]
+	 * The attack/decay speed of the gate. 
+	 * @see {@link Follower.smoothing}
 	 */
 	get smoothing(): Time {
 		return this._follower.smoothing;

package/Tone/component/dynamics/Limiter.ts

@@ -11,7 +11,7 @@ export interface LimiterOptions extends ToneAudioNodeOptions {
 
 /**
  * Limiter will limit the loudness of an incoming signal.
- * Under the hood it's composed of a [[Compressor]] with a fast attack
+ * Under the hood it's composed of a {@link Compressor} with a fast attack
  * and release and max compression ratio. 
  *
  * @example

package/Tone/component/dynamics/MidSideCompressor.ts

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

package/Tone/component/dynamics/MultibandCompressor.ts

@@ -16,7 +16,8 @@ export interface MultibandCompressorOptions extends ToneAudioNodeOptions {
 }
 
 /**
- * A compressor with separate controls over low/mid/high dynamics. See [[Compressor]] and [[MultibandSplit]]
+ * A compressor with separate controls over low/mid/high dynamics. 
+ * @see {@link Compressor} and {@link MultibandSplit}
  *
  * @example
  * const multiband = new Tone.MultibandCompressor({

package/Tone/component/envelope/FrequencyEnvelope.ts

@@ -11,8 +11,8 @@ export interface FrequencyEnvelopeOptions extends EnvelopeOptions {
 	exponent: number;
 }
 /**
- * FrequencyEnvelope is an [[Envelope]] which ramps between [[baseFrequency]]
- * and [[octaves]]. It can also have an optional [[exponent]] to adjust the curve
+ * FrequencyEnvelope is an {@link Envelope} which ramps between {@link baseFrequency}
+ * and {@link octaves}. It can also have an optional {@link exponent} to adjust the curve
  * which it ramps. 
  * @example
  * const oscillator = new Tone.Oscillator().toDestination().start();

package/Tone/component/filter/BiquadFilter.ts

@@ -14,7 +14,7 @@ export interface BiquadFilterOptions extends ToneAudioNodeOptions {
 
 /**
  * Thin wrapper around the native Web Audio [BiquadFilterNode](https://webaudio.github.io/web-audio-api/#biquadfilternode). 
- * BiquadFilter is similar to [[Filter]] but doesn't have the option to set the "rolloff" value. 
+ * BiquadFilter is similar to {@link Filter} but doesn't have the option to set the "rolloff" value. 
  * @category Component
  */
 export class BiquadFilter extends ToneAudioNode<BiquadFilterOptions> {

package/Tone/component/filter/LowpassCombFilter.ts

@@ -14,7 +14,7 @@ interface LowpassCombFilterOptions extends ToneAudioNodeOptions {
 
 /**
  * A lowpass feedback comb filter. It is similar to
- * [[FeedbackCombFilter]], but includes a lowpass filter.
+ * {@link FeedbackCombFilter}, but includes a lowpass filter.
  * @category Component
  */
 export class LowpassCombFilter extends ToneAudioNode<LowpassCombFilterOptions> {

package/Tone/core/Global.ts

@@ -18,7 +18,7 @@ const dummyContext = new DummyContext();
 let globalContext: BaseContext = dummyContext;
 
 /**
- * Returns the default system-wide [[Context]]
+ * Returns the default system-wide {@link Context}
  * @category Core
  */
 export function getContext(): BaseContext {

package/Tone/core/clock/TickParam.ts

@@ -13,7 +13,7 @@ interface TickParamOptions<TypeName extends UnitName> extends ParamOptions<TypeN
 }
 
 /**
- * A Param class just for computing ticks. Similar to the [[Param]] class,
+ * A Param class just for computing ticks. Similar to the {@link Param} class,
  * but offers conversion to BPM values as well as ability to compute tick
  * duration and elapsed ticks
  */
@@ -218,7 +218,7 @@ export class TickParam<TypeName extends "hertz" | "bpm"> extends Param<TypeName>
 	}
 
 	/**
-	 * The inverse of [[ticksToTime]]. Convert a duration in
+	 * The inverse of {@link ticksToTime}. Convert a duration in
 	 * seconds to the corresponding number of ticks accounting for any
 	 * automation curves starting at the given time.
 	 * @param  duration The time interval to convert to ticks.

package/Tone/core/clock/Transport.ts

@@ -756,7 +756,7 @@ export class TransportClass
 
 	/**
 	 * Unsyncs a previously synced signal from the transport's control.
-	 * See Transport.syncSignal.
+	 * @see {@link syncSignal}.
 	 */
 	unsyncSignal(signal: Signal<any>): this {
 		for (let i = this._syncedSignals.length - 1; i >= 0; i--) {

package/Tone/core/clock/TransportEvent.ts

@@ -10,7 +10,7 @@ export interface TransportEventOptions {
 }
 
 /**
- * TransportEvent is an internal class used by [[TransportClass]]
+ * TransportEvent is an internal class used by {@link TransportClass}
  * to schedule events. Do no invoke this class directly, it is
  * handled from within Tone.Transport.
  */

package/Tone/core/context/AbstractParam.ts

@@ -1,7 +1,7 @@
 import { Time, UnitMap, UnitName } from "../type/Units";
 
 /**
- * Abstract base class for [[Param]] and [[Signal]]
+ * Abstract base class for {@link Param} and {@link Signal}
  */
 export abstract class AbstractParam<TypeName extends UnitName> {
 
@@ -37,8 +37,8 @@ export abstract class AbstractParam<TypeName extends UnitName> {
 
 	/**
 	 * Creates a schedule point with the current value at the current time.
-	 * Automation methods like [[linearRampToValueAtTime]] and [[exponentialRampToValueAtTime]]
-	 * require a starting automation value usually set by [[setValueAtTime]]. This method
+	 * Automation methods like {@link linearRampToValueAtTime} and {@link exponentialRampToValueAtTime}
+	 * require a starting automation value usually set by {@link setValueAtTime}. This method
 	 * is useful since it will do a `setValueAtTime` with whatever the currently computed
 	 * value at the given time is. 
 	 * @param time When to add a ramp point.
@@ -196,7 +196,7 @@ export abstract class AbstractParam<TypeName extends UnitName> {
 	abstract cancelScheduledValues(time: Time): this;
 
 	/**
-	 * This is similar to [[cancelScheduledValues]] except
+	 * This is similar to {@link cancelScheduledValues} except
 	 * it holds the automated value at time until the next automated event.
 	 * @example
 	 * return Tone.Offline(() => {

package/Tone/core/context/Context.ts

@@ -349,7 +349,7 @@ export class Context extends BaseContext {
 
 	/**
 	 * Create an audio worklet node from a name and options. The module
-	 * must first be loaded using [[addAudioWorkletModule]].
+	 * must first be loaded using {@link addAudioWorkletModule}.
 	 */
 	createAudioWorkletNode(
 		name: string,
@@ -413,7 +413,7 @@ export class Context extends BaseContext {
 	 * The amount of time into the future events are scheduled. Giving Web Audio
 	 * a short amount of time into the future to schedule events can reduce clicks and
 	 * improve performance. This value can be set to 0 to get the lowest latency.
-	 * Adjusting this value also affects the [[updateInterval]].
+	 * Adjusting this value also affects the {@link updateInterval}.
 	 */
 	get lookAhead(): Seconds {
 		return this._lookAhead;
@@ -452,7 +452,7 @@ export class Context extends BaseContext {
 	}
 
 	/**
-	 * The current audio context time plus a short [[lookAhead]].
+	 * The current audio context time plus a short {@link lookAhead}.
 	 * @example
 	 * setInterval(() => {
 	 * 	console.log("now", Tone.now());
@@ -463,11 +463,11 @@ export class Context extends BaseContext {
 	}
 
 	/**
-	 * The current audio context time without the [[lookAhead]].
-	 * In most cases it is better to use [[now]] instead of [[immediate]] since
-	 * with [[now]] the [[lookAhead]] is applied equally to _all_ components including internal components,
-	 * to making sure that everything is scheduled in sync. Mixing [[now]] and [[immediate]]
-	 * can cause some timing issues. If no lookAhead is desired, you can set the [[lookAhead]] to `0`.
+	 * The current audio context time without the {@link lookAhead}.
+	 * In most cases it is better to use {@link now} instead of {@link immediate} since
+	 * with {@link now} the {@link lookAhead} is applied equally to _all_ components including internal components,
+	 * to making sure that everything is scheduled in sync. Mixing {@link now} and {@link immediate}
+	 * can cause some timing issues. If no lookAhead is desired, you can set the {@link lookAhead} to `0`.
 	 */
 	immediate(): Seconds {
 		return this._context.currentTime;
@@ -475,7 +475,8 @@ export class Context extends BaseContext {
 
 	/**
 	 * Starts the audio context from a suspended state. This is required
-	 * to initially start the AudioContext. See [[start]]
+	 * to initially start the AudioContext. 
+	 * @see {@link start}
 	 */
 	resume(): Promise<void> {
 		if (isAudioContext(this._context)) {
@@ -593,7 +594,7 @@ export class Context extends BaseContext {
 	}
 
 	/**
-	 * Clear the function scheduled by [[setInterval]]
+	 * Clear the function scheduled by {@link setInterval}
 	 */
 	clearInterval(id: number): this {
 		return this.clearTimeout(id);

package/Tone/core/context/Listener.ts

@@ -16,7 +16,7 @@ export interface ListenerOptions extends ToneAudioNodeOptions{
 
 /**
  * Tone.Listener is a thin wrapper around the AudioListener. Listener combined
- * with [[Panner3D]] makes up the Web Audio API's 3D panning system. Panner3D allows you 
+ * with {@link Panner3D} makes up the Web Audio API's 3D panning system. Panner3D allows you 
  * to place sounds in 3D and Listener allows you to navigate the 3D sound environment from
  * a first-person perspective. There is only one listener per audio context. 
  */

package/Tone/core/context/Offline.ts

@@ -6,7 +6,7 @@ import { ToneAudioBuffer } from "./ToneAudioBuffer";
 /**
  * Generate a buffer by rendering all of the Tone.js code within the callback using the OfflineAudioContext.
  * The OfflineAudioContext is capable of rendering much faster than real time in many cases.
- * The callback function also passes in an offline instance of [[Context]] which can be used
+ * The callback function also passes in an offline instance of {@link Context} which can be used
  * to schedule events along the Transport. 
  * @param  callback  All Tone.js nodes which are created and scheduled within this callback are recorded into the output Buffer.
  * @param  duration     the amount of time to record for.

package/Tone/core/context/ToneAudioNode.ts

@@ -20,6 +20,7 @@ export type ToneAudioNodeOptions = ToneWithContextOptions;
 
 /**
  * ToneAudioNode is the base class for classes which process audio.
+ * @category Core
  */
 export abstract class ToneAudioNode<Options extends ToneAudioNodeOptions = ToneAudioNodeOptions>
 	extends ToneWithContext<Options> {
@@ -211,7 +212,7 @@ export abstract class ToneAudioNode<Options extends ToneAudioNodeOptions = ToneA
 
 	/**
 	 * Connect the output to the context's destination node.
-	 * See [[toDestination]]
+	 * @see {@link toDestination}
 	 * @deprecated
 	 */
 	toMaster(): this {

package/Tone/core/context/ToneWithContext.ts

@@ -95,7 +95,7 @@ export abstract class ToneWithContext<Options extends ToneWithContextOptions> ex
 
 	/**
 	 * Convert the incoming time to seconds. 
-	 * This is calculated against the current [[TransportClass]] bpm
+	 * This is calculated against the current {@link TransportClass} bpm
 	 * @example
 	 * const gain = new Tone.Gain();
 	 * setInterval(() => console.log(gain.toSeconds("4n")), 100);

package/Tone/core/index.ts

@@ -35,4 +35,5 @@ export { Unit };
 
 // export the debug stuff as Debug
 import * as debug from "./util/Debug";
+/** @internal */
 export { debug };

package/Tone/core/type/Time.ts

@@ -137,7 +137,7 @@ export class TimeClass<Type extends Seconds | Ticks = Seconds, Unit extends stri
 
 /**
  * Create a TimeClass from a time string or number. The time is computed against the 
- * global Tone.Context. To use a specific context, use [[TimeClass]]
+ * global Tone.Context. To use a specific context, use {@link TimeClass}
  * @param value A value which represents time
  * @param units The value's units if they can't be inferred by the value.
  * @category Unit

package/Tone/core/util/Defaults.ts

@@ -52,6 +52,7 @@ export function deepEquals<T>(arrayA: T[], arrayB: T[]): boolean {
 
 /**
  * Convert an args array into an object.
+ * @internal
  */
 export function optionsFromArguments<T extends object>(
 	defaults: T,
@@ -101,6 +102,7 @@ export function getDefaultsFromInstance<T>(instance: T): BaseToneOptions {
 /**
  * Returns the fallback if the given object is undefined.
  * Take an array of arguments and return a formatted options object.
+ * @internal
  */
 export function defaultArg<T>(given: T, fallback: T): T {
 	if (isUndef(given)) {

package/Tone/core/worklet/ToneAudioWorkletProcessor.worklet.ts

@@ -2,7 +2,7 @@ import { addToWorklet } from "./WorkletGlobalScope";
 
 const toneAudioWorkletProcessor = /* javascript */ `
 	/**
-	 * The base AudioWorkletProcessor for use in Tone.js. Works with the [[ToneAudioWorklet]]. 
+	 * The base AudioWorkletProcessor for use in Tone.js. Works with the {@link ToneAudioWorklet}. 
 	 */
 	class ToneAudioWorkletProcessor extends AudioWorkletProcessor {
 

package/Tone/effect/AutoPanner.ts

@@ -8,7 +8,7 @@ export interface AutoPannerOptions extends LFOEffectOptions {
 }
 
 /**
- * AutoPanner is a [[Panner]] with an [[LFO]] connected to the pan amount. 
+ * AutoPanner is a {@link Panner} with an {@link LFO} connected to the pan amount. 
  * [Related Reading](https://www.ableton.com/en/blog/autopan-chopper-effect-and-more-liveschool/).
  *
  * @example

package/Tone/effect/AutoWah.ts

@@ -19,7 +19,7 @@ export interface AutoWahOptions extends EffectOptions {
 }
 
 /**
- * AutoWah connects a [[Follower]] to a [[Filter]]. 
+ * AutoWah connects a {@link Follower} to a {@link Filter}. 
  * The frequency of the filter, follows the input amplitude curve. 
  * Inspiration from [Tuna.js](https://github.com/Dinahmoe/tuna).
  * 

package/Tone/effect/Chorus.ts

@@ -16,8 +16,8 @@ export interface ChorusOptions extends StereoFeedbackEffectOptions {
 }
 
 /**
- * Chorus is a stereo chorus effect composed of a left and right delay with an [[LFO]] applied to the delayTime of each channel.
- * When [[feedback]] is set to a value larger than 0, you also get Flanger-type effects.
+ * Chorus is a stereo chorus effect composed of a left and right delay with an {@link LFO} applied to the delayTime of each channel.
+ * When {@link feedback} is set to a value larger than 0, you also get Flanger-type effects.
  * Inspiration from [Tuna.js](https://github.com/Dinahmoe/tuna/blob/master/tuna.js).
  * Read more on the chorus effect on [Sound On Sound](http://www.soundonsound.com/sos/jun04/articles/synthsecrets.htm).
  *
@@ -196,7 +196,8 @@ export class Chorus extends StereoFeedbackEffect<ChorusOptions> {
 	}
 
 	/**
-	 * Sync the filter to the transport. See [[LFO.sync]]
+	 * Sync the filter to the transport. 
+	 * @see {@link LFO.sync}
 	 */
 	sync(): this {
 		this._lfoL.sync();

package/Tone/effect/Freeverb.ts

@@ -23,7 +23,7 @@ const allpassFilterFrequencies = [225, 556, 441, 341];
 /**
  * Freeverb is a reverb based on [Freeverb](https://ccrma.stanford.edu/~jos/pasp/Freeverb.html).
  * Read more on reverb on [Sound On Sound](https://web.archive.org/web/20160404083902/http://www.soundonsound.com:80/sos/feb01/articles/synthsecrets.asp).
- * Freeverb is now implemented with an AudioWorkletNode which may result on performance degradation on some platforms. Consider using [[Reverb]].
+ * Freeverb is now implemented with an AudioWorkletNode which may result on performance degradation on some platforms. Consider using {@link Reverb}.
  * @example
  * const freeverb = new Tone.Freeverb().toDestination();
  * freeverb.dampening = 1000;

package/Tone/effect/JCReverb.ts

@@ -28,8 +28,8 @@ const allpassFilterFreqs = [347, 113, 37];
 /**
  * JCReverb is a simple [Schroeder Reverberator](https://ccrma.stanford.edu/~jos/pasp/Schroeder_Reverberators.html)
  * tuned by John Chowning in 1970.
- * It is made up of three allpass filters and four [[FeedbackCombFilter]].
- * JCReverb is now implemented with an AudioWorkletNode which may result on performance degradation on some platforms. Consider using [[Reverb]].
+ * It is made up of three allpass filters and four {@link FeedbackCombFilter}.
+ * JCReverb is now implemented with an AudioWorkletNode which may result on performance degradation on some platforms. Consider using {@link Reverb}.
  * @example
  * const reverb = new Tone.JCReverb(0.4).toDestination();
  * const delay = new Tone.FeedbackDelay(0.5);

package/Tone/effect/LFOEffect.ts

@@ -76,7 +76,8 @@ export abstract class LFOEffect<Options extends LFOEffectOptions> extends Effect
 	}
 
 	/**
-	 * Sync the filter to the transport. See [[LFO.sync]]
+	 * Sync the filter to the transport. 
+	 * @see {@link LFO.sync}
 	 */
 	sync(): this {
 		this._lfo.sync();
@@ -92,7 +93,8 @@ export abstract class LFOEffect<Options extends LFOEffectOptions> extends Effect
 	}
 
 	/**
-	 * The type of the LFO's oscillator: See [[Oscillator.type]]
+	 * The type of the LFO's oscillator. 
+	 * @see {@link Oscillator.type}
 	 * @example
 	 * const autoFilter = new Tone.AutoFilter().start().toDestination();
 	 * const noise = new Tone.Noise().start().connect(autoFilter);

package/Tone/effect/Reverb.ts

@@ -18,7 +18,7 @@ interface ReverbOptions extends EffectOptions {
  * Generates an Impulse Response Buffer
  * with Tone.Offline then feeds the IR into ConvolverNode.
  * The impulse response generation is async, so you have
- * to wait until [[ready]] resolves before it will make a sound. 
+ * to wait until {@link ready} resolves before it will make a sound. 
  *
  * Inspiration from [ReverbGen](https://github.com/adelespinasse/reverbGen).
  * Copyright (c) 2014 Alan deLespinasse Apache 2.0 License.
@@ -45,8 +45,8 @@ export class Reverb extends Effect<ReverbOptions> {
 	private _preDelay: Seconds;
 
 	/**
-	 * Resolves when the reverb buffer is generated. Whenever either [[decay]]
-	 * or [[preDelay]] are set, you have to wait until [[ready]] resolves
+	 * Resolves when the reverb buffer is generated. Whenever either {@link decay}
+	 * or {@link preDelay} are set, you have to wait until {@link ready} resolves
 	 * before the IR is generated with the latest values. 
 	 */
 	ready: Promise<void> = Promise.resolve();

package/Tone/effect/StereoXFeedbackEffect.ts

@@ -7,7 +7,7 @@ export interface StereoXFeedbackEffectOptions extends StereoFeedbackEffectOption
 }
 
 /**
- * Just like a [[StereoFeedbackEffect]], but the feedback is routed from left to right
+ * Just like a {@link StereoFeedbackEffect}, but the feedback is routed from left to right
  * and right to left instead of on the same channel.
  * ```
  * +--------------------------------+ feedbackL <-----------------------------------+

package/Tone/effect/Tremolo.ts

@@ -15,7 +15,7 @@ export interface TremoloOptions extends StereoEffectOptions {
 }
 
 /**
- * Tremolo modulates the amplitude of an incoming signal using an [[LFO]].
+ * Tremolo modulates the amplitude of an incoming signal using an {@link LFO}.
  * The effect is a stereo effect where the modulation phase is inverted in each channel.
  *
  * @example