Typedoc comments

Author: LuisFerLCC

README.md

@@ -25,7 +25,7 @@ npm install @float-toolkit/react
 
 ### Usage
 
-The package export is a **React hook** called `useFloatToolkit`. It returns an object with an `output` state, as well as math functions that also serve as setters for the output.
+The package export is a **React hook** called `useFloatToolkit`. It returns an object with an `output` state, as well as FloatToolkit methods that also serve as setters for the output.
 
 ```js
 import { useEffect } from "react";

src/index.ts

@@ -3,14 +3,31 @@ import { useDebugValue, useMemo, useState } from "react";
 import FloatToolkit, { FloatToolkitOptions, FloatToolkitPrecisionInteger } from "@float-toolkit/core";
 
 namespace ReactFT {
+	/**
+	 * An integer between 1 and 17, which can be used as the default precision for the useFloatToolkit hook.
+	 */
 	export type Precision = FloatToolkitPrecisionInteger;
+
+	/**
+	 * Options that can be set to modify the behavior of the useFloatToolkit hook.
+	 */
 	export interface Options extends FloatToolkitOptions {}
 }
 
+/**
+ * Contains the properties and methods from the FloatToolkit class, as well as special ones for React.
+ */
 interface ReactFT {
+	/**
+	 * 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(): ReactFT.Precision;
 	set defaultPrecision(newPrecision: ReactFT.Precision);
 
+	/**
+	 * The options object used in this instance of useFloatToolkit.
+	 */
 	get options(): ReactFT.Options;
 
 	add(numbers: number[], precision?: ReactFT.Precision): number;
@@ -21,10 +38,30 @@ interface ReactFT {
 	setOptions(options?: ReactFT.Options, resetOutput?: boolean): ReactFT.Options;
 	subtract(numbers: number[], precision?: ReactFT.Precision): number;
 
+	/**
+	 * A reactive state variable containing the returned value from the last method called.
+	 */
 	output: number;
+
+	/**
+	 * Resets the output to 0.
+	 */
 	resetOutput(): void;
 }
 
+/**
+ * A React hook that returns FloatToolkit methods and an `output` state.
+ *
+ * @param defaultPrecision The precision (number of decimals) to use if not specified in the method itself. Can be changed later. Default value if 10.
+ * @param options An optional configuration object.
+ *
+ * @example
+ * import useFloatToolkit from "@float-toolkit/react";
+ *
+ * function Sum() {
+ * 	const { add, output } = useFloatToolkit(2);
+ * }
+ */
 function useFloatToolkit(defaultPrecision?: ReactFT.Precision, options?: ReactFT.Options): ReactFT {
 	const [output, setOutput] = useState(0);
 	useDebugValue(output);