Cleaned up docs

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<DecimalSource>;
     /**
-     * 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<T extends ConversionOptions> = Replace<
     T & BaseConversion,
     {
@@ -117,9 +113,7 @@ export type Conversion<T extends ConversionOptions> = Replace<
     }
 >;
 
-/**
+/** A type that matches any valid {@link Conversion} object. */
- * A type that matches any {@link conversion} object.
- */
 export type GenericConversion = Replace<
     Conversion<ConversionOptions>,
     {

src/game/player.ts

@@ -128,7 +128,7 @@ const playerHandler: ProxyHandler<Record<PropertyKey, any>> = {
 };
 
 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;
     }

src/game/settings.ts

@@ -33,8 +33,7 @@ watch(
 
 declare global {
     /**
-     * Augment the window object so the settings, and hard resetting the settings,
+     * Augment the window object so the settings, and hard resetting the settings, can be accessed from the console.
-     * can be accessed from the console
      */
     interface Window {
         settings: Settings;

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;
     }

src/main.ts

@@ -9,15 +9,14 @@ import { useToast } from "vue-toastification";
 
 declare global {
     /**
-     * Augment the window object so
+     * Augment the window object so the vue app and project info can be accessed from the console.
-     * 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;
     }

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;

src/util/save.ts

@@ -127,8 +127,7 @@ window.onbeforeunload = () => {
 
 declare global {
     /**
-     * Augment the window object so the save function,
+     * Augment the window object so the save function, and the hard reset function can be access from the console.
-     * and the hard reset function can be access from the console
      */
     interface Window {
         save: VoidFunction;