From 9f6d4e4bfa890648696248f6c610e992ace5e43f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Pablo=20P=C3=A9rez?= Date: Mon, 19 Oct 2026 23:08:14 -0500 Subject: [PATCH] docs: fix typos in doc comments (settings, API, synth) --- packages/alphatab/src/AlphaTabApiBase.ts | 6 +++--- packages/alphatab/src/CoreSettings.ts | 4 ++-- packages/alphatab/src/DisplaySettings.ts | 2 +- packages/alphatab/src/Environment.ts | 2 +- packages/alphatab/src/NotationSettings.ts | 2 +- packages/alphatab/src/PlayerSettings.ts | 2 +- packages/alphatab/src/exporter/GpifSoundMapper.ts | 2 +- packages/alphatab/src/generated/CoreSettingsJson.ts | 4 ++-- packages/alphatab/src/generated/DisplaySettingsJson.ts | 2 +- packages/alphatab/src/generated/PlayerSettingsJson.ts | 2 +- packages/alphatab/src/synth/ISynthOutput.ts | 2 +- 11 files changed, 15 insertions(+), 15 deletions(-) diff --git a/packages/alphatab/src/AlphaTabApiBase.ts b/packages/alphatab/src/AlphaTabApiBase.ts index 9e57e72863..68a27f698b 100644 --- a/packages/alphatab/src/AlphaTabApiBase.ts +++ b/packages/alphatab/src/AlphaTabApiBase.ts @@ -1398,7 +1398,7 @@ export class AlphaTabApiBase { * The midi events which will trigger the `midiEventsPlayed` event * @remarks * Gets or sets the midi events which will trigger the `midiEventsPlayed` event. With this filter set you can enable - * that alphaTab will signal any midi events as they are played by the synthesizer. This allows reacing on various low level + * that alphaTab will signal any midi events as they are played by the synthesizer. This allows reacting on various low level * audio playback elements like notes/rests played or metronome ticks. * * Refer to the [related guide](https://alphatab.net/docs/guides/handling-midi-events) to learn more about this feature. @@ -3647,7 +3647,7 @@ export class AlphaTabApiBase { * @remarks * If {@link CoreSettings.enableLazyLoading} is enabled not all partial images of the music sheet might be rendered. * In this case the `renderFinished` event rather represents that the whole music sheet has been layouted and arranged - * and every partial image can be requested for rendering. If you neeed more fine-grained access + * and every partial image can be requested for rendering. If you need more fine-grained access * to the actual layouting and rendering progress, you need to look at the low-level apis {@link IScoreRenderer.partialLayoutFinished} and * {@link IScoreRenderer.partialRenderFinished} accessible via {@link renderer}. * @@ -4126,7 +4126,7 @@ export class AlphaTabApiBase { * This event is fired when the synthesizer played certain midi events. * * @remarks - * This event is fired when the synthesizer played certain midi events. This allows reacing on various low level + * This event is fired when the synthesizer played certain midi events. This allows reacting on various low level * audio playback elements like notes/rests played or metronome ticks. * * Refer to the [related guide](https://www.alphatab.net/docs/guides/handling-midi-events) to learn more about this feature. diff --git a/packages/alphatab/src/CoreSettings.ts b/packages/alphatab/src/CoreSettings.ts index 5b12d4b47c..41fa055b3d 100644 --- a/packages/alphatab/src/CoreSettings.ts +++ b/packages/alphatab/src/CoreSettings.ts @@ -51,7 +51,7 @@ export class CoreSettings { * The full URL to the alphaTab JavaScript file. * @remarks * AlphaTab needs to know the full URL to the script file it is contained in to launch the web workers. AlphaTab will do its best to auto-detect - * this path but in case it fails, this setting can be used to explicitly define it. Altenatively also a global variable `ALPHATAB_ROOT` can + * this path but in case it fails, this setting can be used to explicitly define it. Alternatively also a global variable `ALPHATAB_ROOT` can * be defined before initializing. Please be aware that bundling alphaTab together with other scripts might cause errors * in case those scripts are not suitable for web workers. e.g. if there is a script bundled together with alphaTab that accesses the DOM, * this will cause an error when alphaTab starts this script as worker. @@ -147,7 +147,7 @@ export class CoreSettings { public tex: boolean = false; /** - * The tracks to display for the initally loaded file. + * The tracks to display for the initially loaded file. * @json_raw * @remarks * This setting can be used in combinition with the {@link file} or {@link tex} option. It controls which of the tracks diff --git a/packages/alphatab/src/DisplaySettings.ts b/packages/alphatab/src/DisplaySettings.ts index 0f33b11f83..b3f48dac78 100644 --- a/packages/alphatab/src/DisplaySettings.ts +++ b/packages/alphatab/src/DisplaySettings.ts @@ -43,7 +43,7 @@ export class DisplaySettings { * @category Display * @defaultValue `1` * @remarks - * The stretch force is a setting that controls the spacing of the music notation. AlphaTab uses a varaint of the Gourlay algorithm for spacing which has springs and rods for + * The stretch force is a setting that controls the spacing of the music notation. AlphaTab uses a variant of the Gourlay algorithm for spacing which has springs and rods for * aligning elements. This setting controls the "strength" of the springs. The stronger the springs, the wider the spacing. * * | Force 1 | Force 0.5 | diff --git a/packages/alphatab/src/Environment.ts b/packages/alphatab/src/Environment.ts index eeab497712..5c7db61cc2 100644 --- a/packages/alphatab/src/Environment.ts +++ b/packages/alphatab/src/Environment.ts @@ -735,7 +735,7 @@ export class Environment { */ private static _detectWebPlatform(): WebPlatform { // There might be polyfills or platforms like Electron which have a global process object defined even in the browser. - // We need to differenciate between those platforms and a real nodejs + // We need to differentiate between those platforms and a real nodejs // the webPlatform is currently only relevant on the main process side and not within workers/worklets // so it is OK if we wrongly detect node.js inside them. diff --git a/packages/alphatab/src/NotationSettings.ts b/packages/alphatab/src/NotationSettings.ts index fcb6f41b1a..7e7292ca8e 100644 --- a/packages/alphatab/src/NotationSettings.ts +++ b/packages/alphatab/src/NotationSettings.ts @@ -145,7 +145,7 @@ export enum NotationElement { /** * Parenthesis that are shown for tied bends - * if they are preceeded by bends. + * if they are preceded by bends. */ ParenthesisOnTiedBends = 11, diff --git a/packages/alphatab/src/PlayerSettings.ts b/packages/alphatab/src/PlayerSettings.ts index e53d344ef8..684aeedb58 100644 --- a/packages/alphatab/src/PlayerSettings.ts +++ b/packages/alphatab/src/PlayerSettings.ts @@ -290,7 +290,7 @@ export class PlayerSettings { * @json_read_only * @remarks * This setting configures whether alphaTab provides the default user interaction features like selection of the playback range and "seek on click". - * By default users can select the desired playback range with the mouse and also jump to individual beats by click. This behavior can be contolled with this setting. + * By default users can select the desired playback range with the mouse and also jump to individual beats by click. This behavior can be controlled with this setting. * @deprecated Use {@link enableSeekToClick} and {@link enablePlaybackRangeSelection} individually */ public get enableUserInteraction(): boolean { diff --git a/packages/alphatab/src/exporter/GpifSoundMapper.ts b/packages/alphatab/src/exporter/GpifSoundMapper.ts index 869283cc17..118517a30a 100644 --- a/packages/alphatab/src/exporter/GpifSoundMapper.ts +++ b/packages/alphatab/src/exporter/GpifSoundMapper.ts @@ -146,7 +146,7 @@ export class GpifInstrumentArticulation { * @internal */ export class GpifSoundMapper { - // NOTE: this code is not generated as the midi insturment list is anyhow fixed and should not never change. + // NOTE: this code is not generated as the midi instrument list is anyhow fixed and should not never change. private static _midiProgramInfoLookup: Map = new Map([ [0, new GpifMidiProgramInfo(GpifIconIds.Piano, 'Acoustic Piano')], [1, new GpifMidiProgramInfo(GpifIconIds.Piano, 'Acoustic Piano')], diff --git a/packages/alphatab/src/generated/CoreSettingsJson.ts b/packages/alphatab/src/generated/CoreSettingsJson.ts index 49b5512258..1adfe8a071 100644 --- a/packages/alphatab/src/generated/CoreSettingsJson.ts +++ b/packages/alphatab/src/generated/CoreSettingsJson.ts @@ -17,7 +17,7 @@ export interface CoreSettingsJson { * The full URL to the alphaTab JavaScript file. * @remarks * AlphaTab needs to know the full URL to the script file it is contained in to launch the web workers. AlphaTab will do its best to auto-detect - * this path but in case it fails, this setting can be used to explicitly define it. Altenatively also a global variable `ALPHATAB_ROOT` can + * this path but in case it fails, this setting can be used to explicitly define it. Alternatively also a global variable `ALPHATAB_ROOT` can * be defined before initializing. Please be aware that bundling alphaTab together with other scripts might cause errors * in case those scripts are not suitable for web workers. e.g. if there is a script bundled together with alphaTab that accesses the DOM, * this will cause an error when alphaTab starts this script as worker. @@ -92,7 +92,7 @@ export interface CoreSettingsJson { */ tex?: boolean; /** - * The tracks to display for the initally loaded file. + * The tracks to display for the initially loaded file. * @json_raw * @remarks * This setting can be used in combinition with the {@link file} or {@link tex} option. It controls which of the tracks diff --git a/packages/alphatab/src/generated/DisplaySettingsJson.ts b/packages/alphatab/src/generated/DisplaySettingsJson.ts index 99aedb8f0e..8f6b9a3ab1 100644 --- a/packages/alphatab/src/generated/DisplaySettingsJson.ts +++ b/packages/alphatab/src/generated/DisplaySettingsJson.ts @@ -31,7 +31,7 @@ export interface DisplaySettingsJson { * @category Display * @defaultValue `1` * @remarks - * The stretch force is a setting that controls the spacing of the music notation. AlphaTab uses a varaint of the Gourlay algorithm for spacing which has springs and rods for + * The stretch force is a setting that controls the spacing of the music notation. AlphaTab uses a variant of the Gourlay algorithm for spacing which has springs and rods for * aligning elements. This setting controls the "strength" of the springs. The stronger the springs, the wider the spacing. * * | Force 1 | Force 0.5 | diff --git a/packages/alphatab/src/generated/PlayerSettingsJson.ts b/packages/alphatab/src/generated/PlayerSettingsJson.ts index 7ed2a76f98..731c474f80 100644 --- a/packages/alphatab/src/generated/PlayerSettingsJson.ts +++ b/packages/alphatab/src/generated/PlayerSettingsJson.ts @@ -132,7 +132,7 @@ export interface PlayerSettingsJson { * @json_read_only * @remarks * This setting configures whether alphaTab provides the default user interaction features like selection of the playback range and "seek on click". - * By default users can select the desired playback range with the mouse and also jump to individual beats by click. This behavior can be contolled with this setting. + * By default users can select the desired playback range with the mouse and also jump to individual beats by click. This behavior can be controlled with this setting. * @deprecated Use {@link enableSeekToClick} and {@link enablePlaybackRangeSelection} individually */ enableUserInteraction?: boolean; diff --git a/packages/alphatab/src/synth/ISynthOutput.ts b/packages/alphatab/src/synth/ISynthOutput.ts index baadb676d5..08dfb6cbf0 100644 --- a/packages/alphatab/src/synth/ISynthOutput.ts +++ b/packages/alphatab/src/synth/ISynthOutput.ts @@ -59,7 +59,7 @@ export interface ISynthOutput { addSamples(samples: Float32Array): void; /** - * Called when the samples in the output buffer should be reset. This is neeed for instance when seeking to another position. + * Called when the samples in the output buffer should be reset. This is needed for instance when seeking to another position. */ resetSamples(): void;