docs(all): adjusted module scopes for docs, and some cleanup

z3dev · z3dev · commit a5caba6c9b69 · 2026-04-11T15:42:03.000+09:00
diff --git a/packages/io/dxf-deserializer/src/DxfReader.js b/packages/io/dxf-deserializer/src/DxfReader.js
@@ -177,7 +177,7 @@ const parse = (reader, data) => {
   return reader
 }
 
-/**
+/*
  * Parse the given line in the context of the given reader, emitting group value pairs
  * @param reader {DxfReader} - context DxfReader to use
  * @param line {String} - line to parse
@@ -200,7 +200,7 @@ const parseLine = (reader, line) => {
   }
 }
 
-/**
+/*
  * Parse the given line in the context of the given reader, and update the group
  * @param reader {DxfReader} - context DxfReader to use
  * @param line {String} - line to parse
@@ -216,7 +216,7 @@ const setDxfGroup = (reader, line) => {
   }
 }
 
-/**
+/*
  * Parse the given line in the context of the given reader, and update the (group) value
  * @param reader {DxfReader} - context DxfReader to use
  * @param line {String} - line to parse
diff --git a/packages/modeling/src/curves/bezier/arcLengthToT.js b/packages/modeling/src/curves/bezier/arcLengthToT.js
@@ -20,7 +20,7 @@ import { lengths } from './lengths.js'
  * @param {number} [options.segments=100] the number of segments to use when approximating the curve length.
  * @param {object} bezier a bezier curve.
  * @returns a number in the [0, 1] interval or NaN if the arcLength is negative or greater than the total length of the curve.
- * @alias module:modeling/curves/bezier.arcLengthToT
+ * @alias module:modeling/bezier.arcLengthToT
  */
 export const arcLengthToT = (options, bezier) => {
   const defaults = {
diff --git a/packages/modeling/src/curves/bezier/create.js b/packages/modeling/src/curves/bezier/create.js
@@ -23,7 +23,7 @@
  *
  * @param {Array} points An array with at least 2 elements of either all numbers, or all arrays of numbers that are the same size.
  * @returns {bezier} a new bezier data object
- * @alias module:modeling/curves/bezier.create
+ * @alias module:modeling/bezier.create
  */
 export const create = (points) => {
   if (!Array.isArray(points)) throw new Error('Bezier points must be a valid array/')
diff --git a/packages/modeling/src/curves/bezier/index.js b/packages/modeling/src/curves/bezier/index.js
@@ -1,14 +1,14 @@
 /**
  * Represents a bezier easing function.
  * @see {@link bezier} for data structure information.
- * @module modeling/curves/bezier
+ * @module modeling/bezier
+ *
  * @example
- * import { curves } from '@jscad/modeling'
- * const { bezier } = curves
+ * import { bezier } from '@jscad/modeling'
  */
+export { arcLengthToT } from './arcLengthToT.js'
 export { create } from './create.js'
-export { valueAt } from './valueAt.js'
-export { tangentAt } from './tangentAt.js'
-export { lengths } from './lengths.js'
 export { length } from './length.js'
-export { arcLengthToT } from './arcLengthToT.js'
+export { lengths } from './lengths.js'
+export { tangentAt } from './tangentAt.js'
+export { valueAt } from './valueAt.js'
diff --git a/packages/modeling/src/curves/bezier/length.js b/packages/modeling/src/curves/bezier/length.js
@@ -11,6 +11,6 @@ import { lengths } from './lengths.js'
  * @param {number} segments the number of segments to use when approximating the curve length.
  * @param {object} bezier a bezier curve.
  * @returns an approximation of the curve's length.
- * @alias module:modeling/curves/bezier.length
+ * @alias module:modeling/bezier.length
  */
 export const length = (segments, bezier) => lengths(segments, bezier)[segments]
diff --git a/packages/modeling/src/curves/bezier/lengths.js b/packages/modeling/src/curves/bezier/lengths.js
@@ -11,6 +11,7 @@ import { valueAt } from './valueAt.js'
  * @param {number} segments the number of segments to use when approximating the curve length.
  * @param {object} bezier a bezier curve.
  * @returns an array containing the cumulative length of the segments.
+ * @alias module:modeling/bezier.lengths
  */
 export const lengths = (segments, bezier) => {
   let sum = 0
@@ -25,7 +26,7 @@ export const lengths = (segments, bezier) => {
   return lengths
 }
 
-/**
+/*
  * Calculates the Euclidean distance between two n-dimensional points.
  *
  * @example
diff --git a/packages/modeling/src/curves/bezier/tangentAt.js b/packages/modeling/src/curves/bezier/tangentAt.js
@@ -10,7 +10,7 @@
  * @param {number} t : the position of which to calculate the bezier's tangent value; 0 < t < 1
  * @param {object} bezier : an array with at least 2 elements of either all numbers, or all arrays of numbers that are the same size.
  * @return {array | number} the tangent at the requested position.
- * @alias module:modeling/curves/bezier.tangentAt
+ * @alias module:modeling/bezier.tangentAt
  */
 export const tangentAt = (t, bezier) => {
   if (t < 0 || t > 1) {
diff --git a/packages/modeling/src/curves/bezier/valueAt.js b/packages/modeling/src/curves/bezier/valueAt.js
@@ -11,7 +11,7 @@
  * @param {number} t : the position of which to calculate the value; 0 < t < 1
  * @param {object} bezier : a Bézier curve created with bezier.create().
  * @returns {array | number} the value at the requested position.
- * @alias module:modeling/curves/bezier.valueAt
+ * @alias module:modeling/bezier.valueAt
  */
 export const valueAt = (t, bezier) => {
   if (t < 0 || t > 1) {
diff --git a/packages/modeling/src/curves/index.js b/packages/modeling/src/curves/index.js
@@ -1,8 +1,8 @@
 /**
  * Curves are n-dimensional mathematical constructs that define a path from vertex 0 to vertex 1.
- * @module modeling/curves
+ * @alias module:modeling.curves
+ *
  * @example
- * import { curves } from '@jscad/modeling'
- * const { bezier } = curves
+ * import { bezier } from '@jscad/modeling'
  */
 export * as bezier from './bezier/index.js'
diff --git a/packages/modeling/src/geometries/index.js b/packages/modeling/src/geometries/index.js
@@ -5,13 +5,13 @@
  *
  * @see [Geom2]{@link module:modeling/geom2} - 2D geometry consisting of 2D outlines
  * @see [Geom3]{@link module:modeling/geom3} - 3D geometry consisting of polygons
- * @see [Path2]{@link module:modeling/path2} - 2D geometry consisting of ordered points
- * @see [Path3]{@link module:modeling/path3} - 3D geometry consisting of ordered vertices
- * @see [Poly2]{@link module:modeling/poly2} - 2D polygon consisting of points
- * @see [Poly3]{@link module:modeling/poly3} - 3D polygon consisting of vertices
+ * @see [Path2]{@link module:modeling/path2} - 2D geometry consisting of ordered 2D points
+ * @see [Path3]{@link module:modeling/path3} - 3D geometry consisting of ordered 3D vertices
+ * @see [Poly2]{@link module:modeling/poly2} - 2D polygon consisting of 2D points
+ * @see [Poly3]{@link module:modeling/poly3} - 3D polygon consisting of 3D vertices
  * @see [Slice]{@link module:modeling/slice} - 3D geometry consisting of 3D contours
+ * @alias module:modeling.geometry
  *
- * @module modeling/geometries
  * @example
  * import { geom2, geom3, path2, poly2, poly3, slice } from '@jscad/modeling'
  */
diff --git a/packages/modeling/src/geometries/poly3/plane.js b/packages/modeling/src/geometries/poly3/plane.js
@@ -2,6 +2,8 @@ import * as mplane from '../../maths/plane/index.js'
 
 /**
  * Determine the plane of the given polygon.
+ *
+ * @alias module:modeling/poly3.plane
  */
 export const plane = (polygon) => {
   if (!polygon.plane) {
diff --git a/packages/modeling/src/maths/mat4/isOnlyTransformScale.js b/packages/modeling/src/maths/mat4/isOnlyTransformScale.js
@@ -17,7 +17,7 @@ export const isOnlyTransformScale = (matrix) => (
   matrix[15] === 1
 )
 
-/**
+/*
  * @param {number} num
  * @returns {boolean}
  */
diff --git a/packages/modeling/src/operations/booleans/index.js b/packages/modeling/src/operations/booleans/index.js
@@ -3,6 +3,8 @@
  * to perform logical operations, e.g. remove a hole from a board.
  *
  * In all cases, the function returns the results, and never changes the original shapes.
+ * @module modeling/booleans
+ *
  * @example
  * import { intersect, scission, subtract, union } from '@jscad/modeling'
  */
diff --git a/packages/modeling/src/operations/booleans/intersect.js b/packages/modeling/src/operations/booleans/intersect.js
@@ -13,7 +13,7 @@ import { intersectGeom3 } from './intersectGeom3.js'
  *
  * @param {...Object} geometries - list of geometries
  * @returns {Geom2|Geom3} a new geometry
- * @alias module:modeling.intersect
+ * @alias module:modeling/booleans.intersect
  *
  * @example
  * let myshape = intersect(cube({size: 5}), cube({size: 5, center: [3,3,3]}))
diff --git a/packages/modeling/src/operations/booleans/scission.js b/packages/modeling/src/operations/booleans/scission.js
@@ -8,7 +8,7 @@ import { scissionGeom3 } from './scissionGeom3.js'
  *
  * @param {...Object} objects - list of geometries
  * @returns {Array} list of pieces from each geometry
- * @alias module:modeling.scission
+ * @alias module:modeling/booleans.scission
  *
  * @example
  * let figure = use('./my.stl')
diff --git a/packages/modeling/src/operations/booleans/subtract.js b/packages/modeling/src/operations/booleans/subtract.js
@@ -14,7 +14,7 @@ import { subtractGeom3 } from './subtractGeom3.js'
  *
  * @param {...Object} geometries - list of geometries
  * @returns {Geom2|Geom3} a new geometry
- * @alias module:modeling.subtract
+ * @alias module:modeling/booleans.subtract
  *
  * @example
  * let myshape = subtract(cuboid({size: 5}), cuboid({size: 5, center: [3,3,3]}))
diff --git a/packages/modeling/src/operations/booleans/union.js b/packages/modeling/src/operations/booleans/union.js
@@ -13,7 +13,7 @@ import { unionGeom3 } from './unionGeom3.js'
  *
  * @param {...Object} geometries - list of geometries
  * @returns {Geom2|Geom3} a new geometry
- * @alias module:modeling.union
+ * @alias module:modeling/booleans.union
  *
  * @example
  * let myshape = union(cube({size: 5}), cube({size: 5, center: [3,3,3]}))
diff --git a/packages/modeling/src/operations/minkowski/minkowskiSum.js b/packages/modeling/src/operations/minkowski/minkowskiSum.js
@@ -64,7 +64,7 @@ export const minkowskiSum = (...geometries) => {
   throw new Error('minkowskiSum of two non-convex geometries is not yet supported')
 }
 
-/**
+/*
  * Compute Minkowski sum of non-convex A with convex B.
  *
  * Decomposes A into tetrahedra, computes Minkowski sum of each with B,
@@ -88,7 +88,7 @@ const minkowskiSumNonConvexConvex = (geomA, geomB) => {
   return unionGeom3(parts)
 }
 
-/**
+/*
  * Decompose a geom3 into tetrahedra using face-local apex points.
  * Each resulting tetrahedron is guaranteed to be convex.
  *
@@ -155,7 +155,7 @@ const decomposeIntoTetrahedra = (geometry) => {
   return tetrahedra
 }
 
-/**
+/*
  * Create the 4 triangular faces of a tetrahedron.
  *
  * Tetrahedron has 4 faces, each a triangle
@@ -167,7 +167,7 @@ const createTetrahedronPolygons = (p0, p1, p2, p3) => [
   poly3.create([p2, p0, p3]) // face opposite p1
 ]
 
-/**
+/*
  * Compute Minkowski sum of two convex polyhedra.
  *
  * For convex polyhedra, the Minkowski sum equals the convex hull of
@@ -198,7 +198,7 @@ const minkowskiSumConvex = (geomA, geomB) => {
   return geom3.create(hullPolygons)
 }
 
-/**
+/*
  * Extract unique vertices from a geom3.
  * Uses a Set with string keys for deduplication.
  */

Original file line number	Diff line number	Diff line change
`@@ -177,7 +177,7 @@ const parse = (reader, data) => {`
`177`	`177`	`return reader`
`178`	`178`	`}`
`179`	`179`
`180`		`-/**`
	`180`	`+/*`
`181`	`181`	`* Parse the given line in the context of the given reader, emitting group value pairs`
`182`	`182`	`* @param reader {DxfReader} - context DxfReader to use`
`183`	`183`	`* @param line {String} - line to parse`
`@@ -200,7 +200,7 @@ const parseLine = (reader, line) => {`
`200`	`200`	`}`
`201`	`201`	`}`
`202`	`202`
`203`		`-/**`
	`203`	`+/*`
`204`	`204`	`* Parse the given line in the context of the given reader, and update the group`
`205`	`205`	`* @param reader {DxfReader} - context DxfReader to use`
`206`	`206`	`* @param line {String} - line to parse`
`@@ -216,7 +216,7 @@ const setDxfGroup = (reader, line) => {`
`216`	`216`	`}`
`217`	`217`	`}`
`218`	`218`
`219`		`-/**`
	`219`	`+/*`
`220`	`220`	`* Parse the given line in the context of the given reader, and update the (group) value`
`221`	`221`	`* @param reader {DxfReader} - context DxfReader to use`
`222`	`222`	`* @param line {String} - line to parse`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`*`
`24`	`24`	`* @param {Array} points An array with at least 2 elements of either all numbers, or all arrays of numbers that are the same size.`
`25`	`25`	`* @returns {bezier} a new bezier data object`
`26`		`- * @alias module:modeling/curves/bezier.create`
	`26`	`+ * @alias module:modeling/bezier.create`
`27`	`27`	`*/`
`28`	`28`	`export const create = (points) => {`
`29`	`29`	`if (!Array.isArray(points)) throw new Error('Bezier points must be a valid array/')`