Documentation comments

Author: LuisFerLCC

scripts/versionNumbers.mjs

@@ -8,5 +8,8 @@ writeFileSync(
 	join(cwd(), "src/versionNumbers.ts"),
 	`// AUTOGENERATED. DO NOT MODIFY.
 
+/**
+ * @internal
+ */
 export const versionNumbers = ${JSON.stringify(PackageJSON.version.split("."))};`
 );

src/float-toolkit.module.ts

@@ -2,6 +2,9 @@ import { NgModule } from "@angular/core";
 
 import { FloatToolkit } from "./float-toolkit.service";
 
+/**
+ * Exports the `FloatToolkit` injectable (service).
+ */
 @NgModule({
 	providers: [FloatToolkit],
 })

src/float-toolkit.service.ts

@@ -3,15 +3,33 @@ import FloatToolkitCore from "@float-toolkit/core";
 
 import { versionNumbers } from "./versionNumbers";
 
+/**
+ * An Angular injectable (service) that implements FloatToolkit methods and an `output` property.
+ *
+ * @example
+ * import { FloatToolkit } from "@float-toolkit/angular";
+ *
+ * \@Component({...})
+ * export class SumComponent {
+ * 	constructor(private ft: FloatToolkit) {}
+ * }
+ */
 @Injectable({ providedIn: "root" })
 class FloatToolkit {
 	private readonly ft = new FloatToolkitCore();
 	private _output = 0;
 
+	/**
+	 * A reactive state property containing the returned value of the last method called.
+	 */
 	get output(): number {
 		return this._output;
 	}
 
+	/**
+	 * An integer between 1 and 17.
+	 * Defines the precision (number of decimals) to use by default, if the precision is not specified in the method itself.
+	 */
 	get defaultPrecision(): FloatToolkit.Precision {
 		return this.ft.defaultPrecision;
 	}
@@ -20,6 +38,9 @@ class FloatToolkit {
 		this.ft.defaultPrecision = newPrecision;
 	}
 
+	/**
+	 * The options object used in the service.
+	 */
 	get options(): FloatToolkit.Options {
 		return this.ft.options;
 	}
@@ -69,17 +90,35 @@ class FloatToolkit {
 		return result;
 	}
 
+	/**
+	 * Resets the output to 0.
+	 */
 	resetOutput(): void {
 		this._output = 0;
 	}
 }
 
 namespace FloatToolkit {
+	/**
+	 * An integer between 1 and 17, which can be used as the default precision for the `FloatToolkit` service.
+	 */
 	export type Precision = FloatToolkitCore.Precision;
+
+	/**
+	 * Options that can be set to modify the behavior of the `FloatToolkit` service.
+	 */
 	export interface Options extends FloatToolkitCore.Options {}
+
+	/**
+	 * An object containing the version of a FloatToolkit package.
+	 */
 	export interface Version extends FloatToolkitCore.Version {}
 
+	/**
+	 * Contains the version of `@float-toolkit/core` used by the Angular service.
+	 */
 	export const CORE_VERSION: Version = FloatToolkitCore.VERSION;
+
 	export const VERSION: Version = {
 		get full() {
 			return versionNumbers.join(".");