diff --git a/src/features/conversion.ts b/src/features/conversion.ts index 1dbf5a6..c334b6e 100644 --- a/src/features/conversion.ts +++ b/src/features/conversion.ts @@ -12,12 +12,10 @@ import { createLazyProxy } from "util/proxies"; import type { Ref } from "vue"; import { computed, unref } from "vue"; -/** - * An object that configures a {@link conversion}. - */ +/** An object that configures a {@link Conversion}. */ export interface ConversionOptions { /** - * The scaling function that is used to determine the rate of conversion from one {@link resource} to the other. + * The scaling function that is used to determine the rate of conversion from one {@link Resource} to the other. */ scaling: ScalingFunction; /** @@ -43,11 +41,11 @@ export interface ConversionOptions { */ nextAt?: Computable; /** - * The input {@link resource} for this conversion. + * The input {@link Resource} for this conversion. */ baseResource: Resource; /** - * The output {@link resource} for this conversion. i.e. the resource being generated. + * The output {@link Resource} for this conversion. i.e. the resource being generated. */ gainResource: Resource; /** @@ -101,9 +99,7 @@ export interface BaseConversion { convert: VoidFunction; } -/** - * An object that converts one {@link resource} into another at a given rate. - */ +/** An object that converts one {@link Resource} into another at a given rate. */ export type Conversion = Replace< T & BaseConversion, { @@ -117,9 +113,7 @@ export type Conversion = Replace< } >; -/** - * A type that matches any {@link conversion} object. - */ +/** A type that matches any valid {@link Conversion} object. */ export type GenericConversion = Replace< Conversion, { diff --git a/src/game/player.ts b/src/game/player.ts index 8b4ceb0..fae969c 100644 --- a/src/game/player.ts +++ b/src/game/player.ts @@ -128,7 +128,7 @@ const playerHandler: ProxyHandler> = { }; declare global { - /** Augment the window object so the player can be accessed from the console */ + /** Augment the window object so the player can be accessed from the console. */ interface Window { player: Player; } diff --git a/src/game/settings.ts b/src/game/settings.ts index 5a94555..af295c4 100644 --- a/src/game/settings.ts +++ b/src/game/settings.ts @@ -33,8 +33,7 @@ watch( declare global { /** - * Augment the window object so the settings, and hard resetting the settings, - * can be accessed from the console + * Augment the window object so the settings, and hard resetting the settings, can be accessed from the console. */ interface Window { settings: Settings; diff --git a/src/game/state.ts b/src/game/state.ts index 1154949..00934c4 100644 --- a/src/game/state.ts +++ b/src/game/state.ts @@ -8,7 +8,7 @@ export interface Transient { } declare global { - /** Augment the window object so the transient state can be accessed from the console */ + /** Augment the window object so the transient state can be accessed from the console. */ interface Window { state: Transient; } diff --git a/src/main.ts b/src/main.ts index 5b8cf9c..2896796 100644 --- a/src/main.ts +++ b/src/main.ts @@ -9,15 +9,14 @@ import { useToast } from "vue-toastification"; declare global { /** - * Augment the window object so - * the vue app and project info can be accessed from the console + * Augment the window object so the vue app and project info can be accessed from the console. */ interface Window { vue: VueApp; projInfo: typeof projInfo; } - /** Fix for typedoc treating import functions as taking AssertOptions instead of GlobOptions */ + /** Fix for typedoc treating import functions as taking AssertOptions instead of GlobOptions. */ interface AssertOptions { as: string; } diff --git a/src/util/bignum.ts b/src/util/bignum.ts index 2e047a2..33d180e 100644 --- a/src/util/bignum.ts +++ b/src/util/bignum.ts @@ -18,7 +18,7 @@ export const { export type DecimalSource = RawDecimalSource; declare global { - /** Augment the window object so the big num functions can be access from the console */ + /** Augment the window object so the big num functions can be access from the console. */ interface Window { Decimal: typeof Decimal; exponentialFormat: (num: DecimalSource, precision: number, mantissa: boolean) => string; diff --git a/src/util/save.ts b/src/util/save.ts index c0f96ef..c5a0073 100644 --- a/src/util/save.ts +++ b/src/util/save.ts @@ -127,8 +127,7 @@ window.onbeforeunload = () => { declare global { /** - * Augment the window object so the save function, - * and the hard reset function can be access from the console + * Augment the window object so the save function, and the hard reset function can be access from the console. */ interface Window { save: VoidFunction;