docs: fix docstrings/tags

thi-ng · Feb 11, 2025 · a04fea0 · a04fea0
1 parent f3405d7
commit a04fea0
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 15 deletions.
diff --git a/packages/associative/src/hash-map.ts b/packages/associative/src/hash-map.ts
@@ -20,6 +20,7 @@ import { __equivMap } from "./internal/equiv.js";
 import { __inspectable } from "./internal/inspect.js";
 import { into } from "./into.js";
 
+/** @internal */
 interface HashMapState<K, V> {
 	hash: Fn<K, number>;
 	equiv: Predicate2<K>;
@@ -229,6 +230,7 @@ export class HashMap<K, V>
 		};
 	}
 
+	/** @internal */
 	protected find(key: K, $this: HashMapState<K, V>) {
 		const { bins, equiv, mask } = $this;
 		let i = mask;
@@ -241,6 +243,7 @@ export class HashMap<K, V>
 		return h;
 	}
 
+	/** @internal */
 	protected resize($this: HashMapState<K, V>) {
 		const src = $this.bins;
 		const cap = ($this.mask + 1) * 2;

diff --git a/packages/distance/src/argmin.ts b/packages/distance/src/argmin.ts
@@ -11,7 +11,7 @@ import { DIST_SQ, DIST_SQ1 } from "./squared.js";
  * and returns index of the sample closest to `p` (according to `dist`, default:
  * {@link DIST_SQ}).
  *
- * @reference
+ * @remarks
  * Use {@link argminT} for non-vector inputs.
  *
  * https://en.wikipedia.org/wiki/Arg_max#Arg_min
@@ -62,7 +62,7 @@ export const argminN = (
  * representation, then computes and returns index of the sample closest to `p`
  * (according to `dist`).
  *
- * @reference
+ * @remarks
  * Use {@link argmin} if all items are vectors already.
  *
  * @param p -

diff --git a/packages/egf/src/parser.ts b/packages/egf/src/parser.ts
@@ -234,7 +234,7 @@ const __initContext = (ctx: Partial<ParseContext> = {}) => {
 	};
 };
 
-/** @interal */
+/** @internal */
 export const $parseFile = (path: string, ctx?: Partial<ParseContext>) => {
 	const $ctx = __initContext(ctx);
 	$ctx.file = path = resolvePath($ctx.cwd, path);

diff --git a/packages/geom-axidraw/src/api.ts b/packages/geom-axidraw/src/api.ts
@@ -8,7 +8,7 @@ import type { ReadonlyVec } from "@thi.ng/vectors";
  * Package-specific shape attributes used to control conversion behavior. MUST
  * be stored under the `__axi` attribute name.
  *
- * @remark
+ * @remarks
  * Important: TODO keep this in sync with
  * [PolylineOpts](https://docs.thi.ng/umbrella/axidraw/interfaces/PolylineOpts.html)
  *

diff --git a/packages/geom/src/transform-vertices.ts b/packages/geom/src/transform-vertices.ts
@@ -37,7 +37,7 @@ export type TransformVerticesFn = {
  * provided function, which is being called for each vertex individually and
  * should produce a transformation matrix.
  *
- * @remark
+ * @remarks
  * Some shape types will be automatically converted to other types prior to
  * transformation because they cannot be reliably represented in their original
  * type anymore, this includes:

diff --git a/packages/shader-ast-stdlib/src/color/porter-duff.ts b/packages/shader-ast-stdlib/src/color/porter-duff.ts
@@ -18,7 +18,7 @@ const __coeff = (col: Vec4Sym, f: FloatTerm) =>
  * optimized AST function which accepts 2 RGBA colors (vec4) and returns blended
  * & clamped result (also a vec4).
  *
- * @remark
+ * @remarks
  * All built-in PD operators are defined via this HOF. The two given coefficient
  * functions are used to extract blending coefficients for src/dest colors and
  * are called with the alpha components of both colors.

diff --git a/packages/shader-ast/src/ast/ops.ts b/packages/shader-ast/src/ast/ops.ts
@@ -411,8 +411,8 @@ export function bitxor(l: Term<any> | number, r: Term<any> | number): Op2<any> {
 }
 
 /**
- * @reference
- * GLSL ES Specification 3.0, page 71
+ * @remarks
+ * Reference: GLSL ES Specification 3.0, page 71
  *
  * @param l
  * @param r
@@ -428,8 +428,8 @@ export function lshift(l: Term<any>, r: Term<any>): Op2<any> {
 }
 
 /**
- * @reference
- * GLSL ES Specification 3.0, page 71
+ * @remarks
+ * Reference: GLSL ES Specification 3.0, page 71
  *
  * @param l
  * @param r

diff --git a/packages/strings/src/vector.ts b/packages/strings/src/vector.ts
@@ -7,11 +7,11 @@ import { float } from "./float.js";
  * Higher order formatter for n-D vectors, with each element formatted using
  * `prec` and using optional delimiter and pre/postfixes.
  *
- * @size - vector size (optimized for size 1-4)
- * @prec - precision (see {@link float}) or existing number formatter
- * @delim - delimiter (default: `,`)
- * @pre - prefix (default: `[`)
- * @post - prefix (default: `]`)
+ * @param size - vector size (optimized for size 1-4)
+ * @param prec - precision (see {@link float}) or existing number formatter
+ * @param delim - delimiter (default: `,`)
+ * @param pre - prefix (default: `[`)
+ * @param post - prefix (default: `]`)
  */
 export const vector: (
 	size: number,