diff --git a/src/animation/Animation.d.mts b/src/animation/Animation.d.mts index 2376f7a1..0a689da3 100644 --- a/src/animation/Animation.d.mts +++ b/src/animation/Animation.d.mts @@ -182,7 +182,7 @@ declare class Animation extends EventEmitter { isFinished(): boolean; // checkActive(): void; - // - Internal use only + // - Only used internally /** * Returns ‘true’ if the animation is currently progressing (playing or stopping) @@ -201,7 +201,7 @@ declare class Animation extends EventEmitter { // _getStopDuration(): any; // apply(): void; // reset(): void; - // - Internal use only + // - Only used internally /** * Gets the current state of the animation diff --git a/src/animation/Transition.d.mts b/src/animation/Transition.d.mts index b3e5a256..f586ebea 100644 --- a/src/animation/Transition.d.mts +++ b/src/animation/Transition.d.mts @@ -123,7 +123,7 @@ declare class Transition extends EventEmitter { isRunning(): boolean; // progress(dt: any): void; - // - Internal use only, called by TransitionManager + // - Only used internally, called by TransitionManager // invokeListeners(): void; // - Private diff --git a/src/application/Application.d.mts b/src/application/Application.d.mts index f88090cf..bef27fec 100644 --- a/src/application/Application.d.mts +++ b/src/application/Application.d.mts @@ -155,7 +155,7 @@ declare class Application< // _setOptions(o: any): void; // __construct(): void; // __init(): void; - // - Internal use only + // - Only used internally /** * Update the focus path of the application @@ -169,13 +169,13 @@ declare class Application< // __updateFocus(): void; // __updateFocusRec(): any; // updateFocusSettings(): void; - // - Internal use only + // - Only used internally // _handleFocusSettings(settings: any, prevSettings: any, focused: any, prevFocused: any): void; // - Already defined on Component // __getFocusPath(): any; - // - Internal use only + // - Only used internally /** * Active focus path of the application @@ -202,7 +202,7 @@ declare class Application< // _findChildren(bucket: any, children: any): any; // _withinClickableRange(affectedChildren: any, cursorX: any, cursorY: any): any; // _testCollision(px: any, py: any, cx: any, cy: any, cw: any, ch: any): any; - // - Internal use only + // - Only used internally /** * Shuts down the Application and the Lightning Stage its rendered on. @@ -213,7 +213,7 @@ declare class Application< destroy(): void; // _destroy(): void; - // - Internal use only + // - Only used internally /** * Gets the active Canvas HTML Element used for rendering diff --git a/src/application/Component.d.mts b/src/application/Component.d.mts index 73951e26..ecbe8fe2 100644 --- a/src/application/Component.d.mts +++ b/src/application/Component.d.mts @@ -36,7 +36,7 @@ export type CompileComponentTemplateSpecType< /** * Returns `true` if the CustomKeyHandlers interface is augmented * - * @hidden Internal use only + * @hidden Only used internally */ type IsCustomKeyHandlersAugmented = object extends Required @@ -48,7 +48,7 @@ type IsCustomKeyHandlersAugmented = /** * Signals by SignalMap * - * @hidden Internal use only + * @hidden Only used internally */ export type __Signals> = { [Key in keyof SignalMapType]?: @@ -58,7 +58,7 @@ export type __Signals> = { /** * PassSignals by SignalMap * - * @hidden Internal use only + * @hidden Only used internally */ export type __PassSignals> = { [Key in keyof SignalMapType]?: @@ -1190,7 +1190,7 @@ declare class Component< /** * Phantom type that holds the TemplateSpec. * - * Internal Use Only. NOT AVAILABLE AT RUNTIME. + * Only used internally. NOT AVAILABLE AT RUNTIME. */ readonly __$type_TemplateSpec: CompileComponentTemplateSpecType } diff --git a/src/internalTypes.d.mts b/src/internalTypes.d.mts index 82cd4be2..2f8716e1 100644 --- a/src/internalTypes.d.mts +++ b/src/internalTypes.d.mts @@ -19,7 +19,7 @@ /** * This file contains internal types that are common to multiple modules * - * @hidden Internal use only + * @hidden Only used internally * @module */ import EventEmitter from './EventEmitter.mjs'; @@ -29,7 +29,7 @@ import Element, { IsLooseTypeConfig } from './tree/Element.mjs' /** * Allows all the documentation of a template spec to be inherited by any Element * - * @hidden Internal use only + * @hidden Only used internally */ export type Documentation = { // WARNING: You cannot use conditional key manipulation here or it will not allow documentation to be passed down @@ -48,7 +48,7 @@ import Element, { IsLooseTypeConfig } from './tree/Element.mjs' * ReduceSpecificity === boolean * ``` * - * @hidden Internal use only + * @hidden Only used internally */ export type ReduceSpecificity = U extends U @@ -80,7 +80,7 @@ export type ReduceSpecificity = /** * Extracts the EventMapType from Element Config * - * @hidden Internal use only + * @hidden Only used internally */ export type EventMapType = IsLooseTypeConfig extends true @@ -90,14 +90,14 @@ export type EventMapType = /** * Extracts the TextureType from Element TypeConfig * - * @hidden Internal use only + * @hidden Only used internally */ export type TextureType = TypeConfig['TextureType']; /** * Extracts the SignalMapType from Component TypeConfig * - * @hidden Internal use only + * @hidden Only used internally */ export type SignalMapType = IsLooseTypeConfig extends true @@ -113,7 +113,7 @@ export type SignalMapType = * from an EventMap function signature without having to enforce a generic constraint on all * EventMaps, which isn't practical without blowing up type safety. * - * @hidden Internal use only + * @hidden Only used internally */ export type HandlerParameters = PossibleFunction extends (...args: any[]) => any @@ -129,7 +129,7 @@ export type HandlerParameters = * @privateRemarks * Like HandlerParameter above, this is a "safe" version of the included `ReturnType` type. * - * @hidden Internal use only + * @hidden Only used internally */ export type HandlerReturnType = PossibleFunction extends (...args: any[]) => any @@ -141,14 +141,14 @@ export type HandlerReturnType = /** * Set of all capital letters * - * @hidden Internal use only + * @hidden Only used internally */ type Alphabet = 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I' | 'J' | 'K' | 'L' | 'M' | 'N' | 'O' | 'P' | 'Q' | 'R' | 'S' | 'T' | 'U' | 'V' | 'W' | 'X' | 'Y' | 'Z'; /** * Any string that begins with a capital letter * - * @hidden Internal use only + * @hidden Only used internally */ export type ValidRef = `${Alphabet}${string}`; @@ -156,7 +156,7 @@ export type ValidRef = `${Alphabet}${string}`; * Returns `true` if T is a type that should terminate the calculation of * tag paths. * - * @hidden Internal use only + * @hidden Only used internally */ type IsTerminus = T extends (string | number | boolean | any[] | Element.Constructor | Element) @@ -210,7 +210,7 @@ type IsTerminus = * ['MyParentElement', 'MyChildElement', 'MyGrandChildElement', [object]]; * ``` * - * @hidden Internal use only + * @hidden Only used internally */ export type SpecToTagPaths = IsTerminus extends true @@ -224,7 +224,7 @@ export type SpecToTagPaths = /** * Joins the given path string tuple into a single `.` separated string tag path * - * @hidden Internal use only + * @hidden Only used internally */ export type Join = T extends [] ? never : @@ -276,7 +276,7 @@ export type Join = * } * ``` * - * @hidden Internal use only + * @hidden Only used internally */ export type CombineTagPaths = { [PathWithType in TagPaths as PathWithType extends [...infer Path extends string[], [any]] ? Join : never]: diff --git a/src/textures/TextTexture.d.mts b/src/textures/TextTexture.d.mts index 679955dd..e6e029ad 100644 --- a/src/textures/TextTexture.d.mts +++ b/src/textures/TextTexture.d.mts @@ -462,7 +462,7 @@ declare class TextTexture extends Texture implements Required; - // - Internal use only + // - Internal Types get text(): string; diff --git a/src/tree/Element.d.mts b/src/tree/Element.d.mts index abe970d6..7430aa21 100644 --- a/src/tree/Element.d.mts +++ b/src/tree/Element.d.mts @@ -41,7 +41,7 @@ import TextureSource from "./TextureSource.mjs"; * Filters out any non-ref keys from an inline Element template and returns the filtered * type with Strong Element template spec. * - * @hidden Internal use only + * @hidden Only used internally */ export type InlineElement = { [P in keyof ElementTemplate as P extends ValidRef ? P : never]: @@ -51,7 +51,7 @@ export type InlineElement = { /** * An object keyed by transitionable Element properties * - * @hidden Internal use only + * @hidden Only used internally */ export type SmoothTemplate = { [P in keyof TemplateSpecType]?: @@ -66,7 +66,7 @@ export type SmoothTemplate = { * An object keyed by transitionable Element properties (numeric properties) * and valued by {@link lng.types.TransitionSettings.Literal} * - * @hidden Internal use only + * @hidden Only used internally */ export type TransitionsTemplate = { [P in keyof TemplateSpecType]?: @@ -83,7 +83,7 @@ export type TransitionsTemplate = { * @privateRemarks * Used to build: __$type_TemplateSpec * - * @hidden Internal use only + * @hidden Only used internally */ export type CompileElementTemplateSpecType< TemplateSpecType extends Element.TemplateSpec, @@ -98,7 +98,7 @@ export type CompileElementTemplateSpecType< * If `PossibleElementConstructor` is an inline Element or a Component Constructor, convert it to it's instantiated form. * Otherwise, return the input type (or something else by setting `Default`) * - * @hidden Internal use only + * @hidden Only used internally */ export type TransformPossibleElement = string extends Key @@ -132,7 +132,7 @@ export type IsLooseTypeConfig = string ex * Converts a loose Element template to a strong Element template by * removing the index signature that Element.TemplateSpecLoose adds * - * @hidden Internal use only + * @hidden Only used internally */ export type RemoveIndex = { [ K in keyof T as string extends K ? never : number extends K ? never : K ] : T[K] @@ -173,7 +173,7 @@ export type RemoveIndex = { * } * ``` * - * @hidden Internal use only + * @hidden Only used internally */ export type TemplateSpecTags = { [K in keyof CombineTagPaths>>]: TransformPossibleElement>>[K]>; @@ -189,7 +189,7 @@ export type TemplateSpecTags = { * @privateRemarks * The refs are transformed into proper Element / Component references * - * @hidden Internal use only + * @hidden Only used internally */ export type TemplateSpecRefs = { [K in keyof CombineTagPathsSingleLevel>>]: TransformPossibleElement>>[K]>; @@ -1407,10 +1407,10 @@ declare class Element< readonly displayedTexture: TextureType | null; // onTextureSourceLoaded() { - // - Internal use only. Calling/overriding this can break things + // - Only used internally. Calling/overriding this can break things // onTextureSourceLoadError(error: unknown): void; - // - Internal use only. Calling/overriding this can break things + // - Only used internally. Calling/overriding this can break things /** * Force re-create of render texture and re-invoke shader @@ -1418,13 +1418,13 @@ declare class Element< forceRenderUpdate(): void; // onDisplayedTextureClippingChanged - // - Internal use only. Calling/overriding this can break things + // - Only used internally. Calling/overriding this can break things // onPrecisionChanged - // - Internal use only. Calling/overriding this can break things + // - Only used internally. Calling/overriding this can break things // onDimensionsChanged(w: number, h: number): void; - // - Internal use only. Calling/overriding this can break things + // - Only used internally. Calling/overriding this can break things /** * Get the corner points of this Element @@ -1507,7 +1507,7 @@ declare class Element< getSettings(): Element.TemplateSpec; // getNonDefaults() { - // - Internal use only + // - Only used internally /** * `true` if Element is within the bounds margin @@ -1915,7 +1915,7 @@ declare class Element< // get tags() { // set tags(v) { // set t(v) { - // - These tag related methods/properties seem very internal use only and it's not clear if there's a + // - These tag related methods/properties seem very Only used internally and it's not clear if there's a // practical external use // static getGetter(propertyPath) { // static getSetter(propertyPath) { diff --git a/src/tree/Stage.d.mts b/src/tree/Stage.d.mts index fc67256a..0a4df64d 100644 --- a/src/tree/Stage.d.mts +++ b/src/tree/Stage.d.mts @@ -353,25 +353,25 @@ declare class Stage extends EventEmitter { >(optionKey: T): O; // _setOptions(o: Partial): void; - // - Internal use only + // - Only used internally /** * Sets the active application root for the stage */ // setApplication(app: Application): void; - // - Internal Use Only + // - Only used internally /** * Initializes the Stage */ // init(): void; - // Internal Use Only + // Only used internally /** * Destroy's the Stage */ // destroy(): void; - // - Internal Use Only + // - Only used internally /** * Stops the rendering loop @@ -408,13 +408,13 @@ declare class Stage extends EventEmitter { getRenderPrecision(): number; // addUpdateSourceTexture(texture: any): void; - // - Internal Use Only + // - Only used internally // removeUpdateSourceTexture(texture: any): void; - // - Internal Use Only + // - Only used internally // hasUpdateSourceTexture(texture: any): any; - // - Internal Use Only + // - Only used internally /** * Updates and renders a new frame @@ -427,7 +427,7 @@ declare class Stage extends EventEmitter { isUpdatingFrame(): boolean; // renderFrame(): void; - // - Internal Use Only + // - Only used internally /** * Force a re-render @@ -548,7 +548,7 @@ declare class Stage extends EventEmitter { get coordsHeight(): number; // addMemoryUsage(delta: any): void; - // - Internal use only. + // - Only used internally. /** * Amount of memory used (in pixels) */ @@ -583,7 +583,7 @@ declare class Stage extends EventEmitter { // gcTextureMemory(aggressive?: any): void; // gcRenderTextureMemory(aggressive?: any): void; - // - Internal use only by `gc()` + // - Only used internally by `gc()` /** * Creates a new Canvas Element for use for offscreen drawing