Skip to content

Commit 3dd2cb9

Browse files
committed
docs(modeling): adjusted docs for minkowski functions
1 parent ff6f608 commit 3dd2cb9

3 files changed

Lines changed: 5 additions & 4 deletions

File tree

jsdoc.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
"packages/modeling/src/operations/extrusions",
2828
"packages/modeling/src/operations/extrusions/slice",
2929
"packages/modeling/src/operations/hulls",
30+
"packages/modeling/src/operations/minkowski",
3031
"packages/modeling/src/operations/modifiers",
3132
"packages/modeling/src/operations/transforms",
3233
"packages/modeling/src/primitives",

packages/modeling/src/operations/minkowski/index.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@
77
* - Collision detection (shapes collide iff their Minkowski difference contains origin)
88
* - Motion planning and swept volumes
99
*
10-
* @module modeling/operations/minkowski
10+
* @module modeling/minkowski
1111
* @example
12-
* const { minkowski } = require('@jscad/modeling').operations
13-
* const rounded = minkowski.minkowskiSum(cube, sphere)
12+
* const { minkowskiSum } = require('@jscad/modeling').minkowski
13+
* const rounded = minkowskiSum(cube, sphere)
1414
*/
1515
module.exports = {
1616
minkowskiSum: require('./minkowskiSum')

packages/modeling/src/operations/minkowski/minkowskiSum.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ const unionGeom3 = require('../booleans/unionGeom3')
2222
*
2323
* @param {...Object} geometries - two geom3 geometries (second should be convex for non-convex first)
2424
* @returns {geom3} new 3D geometry representing the Minkowski sum
25-
* @alias module:modeling/operations/minkowski.minkowskiSum
25+
* @alias module:modeling/minkowski.minkowskiSum
2626
*
2727
* @example
2828
* const { primitives, minkowski } = require('@jscad/modeling')

0 commit comments

Comments
 (0)