melonjs 14.0.2 → 14.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "melonjs",
-  "version": "14.0.2",
+  "version": "14.1.0",
   "description": "melonJS Game Engine",
   "homepage": "http://www.melonjs.org/",
   "type": "module",
@@ -35,12 +35,14 @@
   "author": "Olivier Biot (AltByte Pte Ltd)",
   "funding": "https://github.com/sponsors/melonjs",
   "engines": {
-    "node": ">= 16"
+    "node": ">= 19"
   },
   "main": "dist/melonjs.module.js",
-  "module": "dist/melonjs.module.js",
+  "module": "dist/melonjs.mjs/index.js",
   "types": "dist/melonjs.module.d.ts",
+  "sideEffects": false,
   "files": [
+    "dist/melonjs.mjs",
     "dist/melonjs.module.js",
     "dist/melonjs.module.d.ts",
     "src/",
@@ -51,31 +53,34 @@
   ],
   "dependencies": {
     "@teppeis/multimaps": "^2.0.0",
-    "core-js": "^3.25.5",
+    "core-js": "^3.26.0",
     "earcut": "2.2.4",
     "eventemitter3": "^4.0.7",
     "howler": "2.2.3"
   },
   "devDependencies": {
+    "@babel/eslint-parser": "^7.19.1",
+    "@babel/plugin-syntax-import-assertions": "^7.20.0",
     "@fastify/static": "^6.5.0",
     "@melonjs/webdoc-theme": "^1.1.1",
-    "@rollup/plugin-commonjs": "^23.0.0",
-    "@rollup/plugin-image": "^2.1.1",
-    "@rollup/plugin-node-resolve": "^14.1.0",
-    "@rollup/plugin-replace": "^4.0.0",
+    "@rollup/plugin-commonjs": "^23.0.2",
+    "@rollup/plugin-image": "^3.0.1",
+    "@rollup/plugin-node-resolve": "^15.0.1",
+    "@rollup/plugin-replace": "^5.0.1",
     "@types/offscreencanvas": "^2019.7.0",
-    "@webdoc/cli": "^2.1.2",
-    "chromedriver": "^106.0.1",
+    "@webdoc/cli": "^2.2.0",
+    "chromedriver": "^107.0.1",
     "cross-env": "^7.0.3",
     "del-cli": "^5.0.0",
-    "eslint": "^8.25.0",
-    "expect": "^29.2.0",
+    "eslint": "^8.26.0",
+    "eslint-plugin-jsdoc": "^39.3.25",
+    "expect": "^29.2.2",
     "expect-mocha-image-snapshot": "^2.0.14",
     "fastify": "^4.9.1",
     "mocha": "^10.1.0",
     "npm-self-link": "^1.1.7",
-    "puppeteer": "^19.0.0",
-    "rollup": "^2.79.1",
+    "puppeteer": "^19.2.0",
+    "rollup": "^3.2.3",
     "rollup-plugin-bundle-size": "^1.0.3",
     "rollup-plugin-string": "^3.0.0",
     "terser": "^5.15.1",
@@ -83,8 +88,8 @@
   },
   "scripts": {
     "build": "npm run lint && rollup -c --silent",
-    "dist": " npm run build && mkdirp dist && cp -f build/*.js dist/ && npm run types",
-    "lint": "eslint src rollup.config.js",
+    "dist": " npm run build && mkdirp dist && cp -fR build/*.* dist/ && npm run types",
+    "lint": "eslint src/** rollup.config.js",
     "pretest": "cp -f ./build/melonjs.module.js ./tests/browser/public/lib",
     "test": "npm run test-node && mocha ./tests/browser/spec/*.js --reporter spec --bail --timeout 10000",
     "test-node": "node build/melonjs.module.js",
@@ -93,7 +98,7 @@
     "doc": "npm run doc-prod",
     "serve": "python3 -m http.server",
     "prepublishOnly": "npm run dist && npm run test",
-    "clean": "del-cli --force build/*.js dist/*.js dist/*.d.ts docs src/**/*.d.ts",
+    "clean": "del-cli --force build/*.* dist/*.* docs",
     "types": "tsc src/index.js --declaration --allowJs --emitDeclarationOnly --outfile dist/melonjs.module.d.ts"
   }
 }

package/src/application/application.js

@@ -157,8 +157,8 @@ class Application {
 
     /**
      * update all objects related to this game active scene/stage
-     * @param {number} time current timestamp as provided by the RAF callback
-     * @param {Stage} stage the current stage
+     * @param {number} time - current timestamp as provided by the RAF callback
+     * @param {Stage} stage - the current stage
      */
     update(time, stage) {
         // handle frame skipping if required
@@ -203,7 +203,7 @@ class Application {
 
     /**
      * draw the active scene/stage associated to this game
-     * @param {Stage} stage the current stage
+     * @param {Stage} stage - the current stage
      */
     draw(stage) {
         if (renderer.isContextValid === true && (this.isDirty || this.isAlwaysDirty)) {

package/src/audio/audio.js

@@ -84,7 +84,7 @@ export let stopOnAudioError = true;
  * It is important to remember that melonJS selects the first compatible sound based on the list of extensions and given order passed here.
  * So if you want webm to be used before mp3, you need to put the audio format in that order.
  * @function audio.init
- * @param {string} [format="mp3"] audio format to prioritize
+ * @param {string} [format="mp3"] - audio format to prioritize
  * @returns {boolean} Indicates whether audio initialization was successful
  * @example
  * // initialize the "sound engine", giving "webm" as default desired audio format, and "mp3" as a fallback
@@ -103,7 +103,7 @@ export let stopOnAudioError = true;
 /**
  * check if the given audio format is supported
  * @function audio.hasFormat
- * @param {string} codec audio format : "mp3", "mpeg", opus", "ogg", "oga", "wav", "aac", "caf", "m4a", "m4b", "mp4", "weba", "webm", "dolby", "flac"
+ * @param {string} codec - audio format : "mp3", "mpeg", opus", "ogg", "oga", "wav", "aac", "caf", "m4a", "m4b", "mp4", "weba", "webm", "dolby", "flac"
  * @returns {boolean} return true if the given audio format is supported
  */
 export function hasFormat(codec) {
@@ -186,10 +186,10 @@ export function load(sound, html5, onload_cb, onerror_cb) {
 /**
  * play the specified sound
  * @function audio.play
- * @param {string} sound_name audio clip name - case sensitive
- * @param {boolean} [loop=false] loop audio
- * @param {Function} [onend] Function to call when sound instance ends playing.
- * @param {number} [volume=default] Float specifying volume (0.0 - 1.0 values accepted).
+ * @param {string} sound_name - audio clip name - case sensitive
+ * @param {boolean} [loop=false] - loop audio
+ * @param {Function} [onend] - Function to call when sound instance ends playing.
+ * @param {number} [volume=default] - Float specifying volume (0.0 - 1.0 values accepted).
  * @returns {number} the sound instance ID.
  * @example
  * // play the "cling" audio clip
@@ -227,11 +227,11 @@ export function play(sound_name, loop = false, onend, volume) {
 /**
  * Fade a currently playing sound between two volumee.
  * @function audio.fade
- * @param {string} sound_name audio clip name - case sensitive
- * @param {number} from Volume to fade from (0.0 to 1.0).
- * @param {number} to Volume to fade to (0.0 to 1.0).
- * @param {number} duration Time in milliseconds to fade.
- * @param {number} [id] the sound instance ID. If none is passed, all sounds in group will fade.
+ * @param {string} sound_name - audio clip name - case sensitive
+ * @param {number} from - Volume to fade from (0.0 to 1.0).
+ * @param {number} to - Volume to fade to (0.0 to 1.0).
+ * @param {number} duration - Time in milliseconds to fade.
+ * @param {number} [id] - the sound instance ID. If none is passed, all sounds in group will fade.
  */
 export function fade(sound_name, from, to, duration, id) {
     var sound = audioTracks[sound_name];
@@ -245,9 +245,9 @@ export function fade(sound_name, from, to, duration, id) {
 /**
  * get/set the position of playback for a sound.
  * @function audio.seek
- * @param {string} sound_name audio clip name - case sensitive
- * @param {number} [seek] the position to move current playback to (in seconds).
- * @param {number} [id] the sound instance ID. If none is passed, all sounds in group will changed.
+ * @param {string} sound_name - audio clip name - case sensitive
+ * @param {number} [seek] - the position to move current playback to (in seconds).
+ * @param {number} [id] - the sound instance ID. If none is passed, all sounds in group will changed.
  * @returns {number} return the current seek position (if no extra parameters were given)
  * @example
  * // return the current position of the background music
@@ -267,9 +267,9 @@ export function seek(sound_name, ...args) {
 /**
  * get or set the rate of playback for a sound.
  * @function audio.rate
- * @param {string} sound_name audio clip name - case sensitive
- * @param {number} [rate] playback rate : 0.5 to 4.0, with 1.0 being normal speed.
- * @param {number} [id] the sound instance ID. If none is passed, all sounds in group will be changed.
+ * @param {string} sound_name - audio clip name - case sensitive
+ * @param {number} [rate] - playback rate : 0.5 to 4.0, with 1.0 being normal speed.
+ * @param {number} [id] - the sound instance ID. If none is passed, all sounds in group will be changed.
  * @returns {number} return the current playback rate (if no extra parameters were given)
  * @example
  * // get the playback rate of the background music
@@ -289,8 +289,8 @@ export function rate(sound_name, ...args) {
 /**
  * stop the specified sound on all channels
  * @function audio.stop
- * @param {string} [sound_name] audio clip name (case sensitive). If none is passed, all sounds are stopped.
- * @param {number} [id] the sound instance ID. If none is passed, all sounds in group will stop.
+ * @param {string} [sound_name] - audio clip name (case sensitive). If none is passed, all sounds are stopped.
+ * @param {number} [id] - the sound instance ID. If none is passed, all sounds in group will stop.
  * @example
  * me.audio.stop("cling");
  */
@@ -313,8 +313,8 @@ export function stop(sound_name, id) {
  * pause the specified sound on all channels<br>
  * this function does not reset the currentTime property
  * @function audio.pause
- * @param {string} sound_name audio clip name - case sensitive
- * @param {number} [id] the sound instance ID. If none is passed, all sounds in group will pause.
+ * @param {string} sound_name - audio clip name - case sensitive
+ * @param {number} [id] - the sound instance ID. If none is passed, all sounds in group will pause.
  * @example
  * me.audio.pause("cling");
  */
@@ -330,8 +330,8 @@ export function pause(sound_name, id) {
 /**
  * resume the specified sound on all channels<br>
  * @function audio.resume
- * @param {string} sound_name audio clip name - case sensitive
- * @param {number} [id] the sound instance ID. If none is passed, all sounds in group will resume.
+ * @param {string} sound_name - audio clip name - case sensitive
+ * @param {number} [id] - the sound instance ID. If none is passed, all sounds in group will resume.
  * @example
  * // play a audio clip
  * var id = me.audio.play("myClip");
@@ -356,8 +356,8 @@ export function resume(sound_name, id) {
  * this function automatically set the loop property to true<br>
  * and keep track of the current sound being played.
  * @function audio.playTrack
- * @param {string} sound_name audio track name - case sensitive
- * @param {number} [volume=default] Float specifying volume (0.0 - 1.0 values accepted).
+ * @param {string} sound_name - audio track name - case sensitive
+ * @param {number} [volume=default] - Float specifying volume (0.0 - 1.0 values accepted).
  * @returns {number} the sound instance ID.
  * @example
  * me.audio.playTrack("awesome_music");
@@ -430,7 +430,7 @@ export function getCurrentTrack() {
 /**
  * set the default global volume
  * @function audio.setVolume
- * @param {number} volume Float specifying volume (0.0 - 1.0 values accepted).
+ * @param {number} volume - Float specifying volume (0.0 - 1.0 values accepted).
  */
 export function setVolume(volume) {
     Howler.volume(volume);
@@ -448,9 +448,9 @@ export function getVolume() {
 /**
  * mute or unmute the specified sound, but does not pause the playback.
  * @function audio.mute
- * @param {string} sound_name audio clip name - case sensitive
- * @param {number} [id] the sound instance ID. If none is passed, all sounds in group will mute.
- * @param {boolean} [mute=true] True to mute and false to unmute
+ * @param {string} sound_name - audio clip name - case sensitive
+ * @param {number} [id] - the sound instance ID. If none is passed, all sounds in group will mute.
+ * @param {boolean} [mute=true] - True to mute and false to unmute
  * @example
  * // mute the background music
  * me.audio.mute("awesome_music");
@@ -469,8 +469,8 @@ export function mute(sound_name, id, mute) {
 /**
  * unmute the specified sound
  * @function audio.unmute
- * @param {string} sound_name audio clip name
- * @param {number} [id] the sound instance ID. If none is passed, all sounds in group will unmute.
+ * @param {string} sound_name - audio clip name
+ * @param {number} [id] - the sound instance ID. If none is passed, all sounds in group will unmute.
  */
 export function unmute(sound_name, id) {
     mute(sound_name, id, false);
@@ -504,7 +504,7 @@ export function muted() {
 /**
  * unload specified audio track to free memory
  * @function audio.unload
- * @param {string} sound_name audio track name - case sensitive
+ * @param {string} sound_name - audio track name - case sensitive
  * @returns {boolean} true if unloaded
  * @example
  * me.audio.unload("awesome_music");

package/src/camera/camera2d.js

@@ -25,10 +25,10 @@ var targetV = new Vector2d();
  */
 class Camera2d extends Renderable {
     /**
-     * @param {number} minX start x offset
-     * @param {number} minY start y offset
-     * @param {number} maxX end x offset
-     * @param {number} maxY end y offset
+     * @param {number} minX - start x offset
+     * @param {number} minY - start y offset
+     * @param {number} maxX - end x offset
+     * @param {number} maxY - end y offset
      */
     constructor(minX, minY, maxX, maxY) {
         super(minX, minY, maxX - minX, maxY - minY);
@@ -237,8 +237,8 @@ class Camera2d extends Renderable {
      * @name setDeadzone
      * @see Camera2d.follow
      * @memberof Camera2d
-     * @param {number} w deadzone width
-     * @param {number} h deadzone height
+     * @param {number} w - deadzone width
+     * @param {number} h - deadzone height
      */
     setDeadzone(w, h) {
         if (typeof(this.deadzone) === "undefined") {
@@ -264,8 +264,8 @@ class Camera2d extends Renderable {
      * resize the camera
      * @name resize
      * @memberof Camera2d
-     * @param {number} w new width of the camera
-     * @param {number} h new height of the camera
+     * @param {number} w - new width of the camera
+     * @param {number} h - new height of the camera
      * @returns {Camera2d} this camera
      */
     resize(w, h) {
@@ -295,10 +295,10 @@ class Camera2d extends Renderable {
      * the camera is bound to the given coordinates and cannot move/be scrolled outside of it.
      * @name setBounds
      * @memberof Camera2d
-     * @param {number} x world left limit
-     * @param {number} y world top limit
-     * @param {number} w world width limit
-     * @param {number} h world height limit
+     * @param {number} x - world left limit
+     * @param {number} y - world top limit
+     * @param {number} w - world width limit
+     * @param {number} h - world height limit
      */
     setBounds(x, y, w, h) {
         this.smoothFollow = false;
@@ -313,9 +313,9 @@ class Camera2d extends Renderable {
      * (this will put the camera center around the given target)
      * @name follow
      * @memberof Camera2d
-     * @param {Renderable|Vector2d} target renderable or position vector to follow
-     * @param {number} [axis=me.game.viewport.AXIS.BOTH] Which axis to follow (see {@link Camera2d.AXIS})
-     * @param {number} [damping=1] default damping value
+     * @param {Renderable|Vector2d} target - renderable or position vector to follow
+     * @param {number} [axis=me.game.viewport.AXIS.BOTH] - Which axis to follow (see {@link Camera2d.AXIS})
+     * @param {number} [damping=1] - default damping value
      * @example
      * // set the camera to follow this renderable on both axis, and enable damping
      * me.game.viewport.follow(this, me.game.viewport.AXIS.BOTH, 0.1);
@@ -503,12 +503,12 @@ class Camera2d extends Renderable {
      * shake the camera
      * @name shake
      * @memberof Camera2d
-     * @param {number} intensity maximum offset that the screen can be moved
+     * @param {number} intensity - maximum offset that the screen can be moved
      * while shaking
-     * @param {number} duration expressed in milliseconds
-     * @param {number} [axis=me.game.viewport.AXIS.BOTH] specify on which axis to apply the shake effect (see {@link Camera2d.AXIS})
-     * @param {Function} [onComplete] callback once shaking effect is over
-     * @param {boolean} [force] if true this will override the current effect
+     * @param {number} duration - expressed in milliseconds
+     * @param {number} [axis=me.game.viewport.AXIS.BOTH] - specify on which axis to apply the shake effect (see {@link Camera2d.AXIS})
+     * @param {Function} [onComplete] - callback once shaking effect is over
+     * @param {boolean} [force] - if true this will override the current effect
      * @example
      * // shake it baby !
      * me.game.viewport.shake(10, 500, me.game.viewport.AXIS.BOTH);
@@ -527,9 +527,9 @@ class Camera2d extends Renderable {
      * screen is filled with the specified color and slowly goes back to normal
      * @name fadeOut
      * @memberof Camera2d
-     * @param {Color|string} color a CSS color value
-     * @param {number} [duration=1000] expressed in milliseconds
-     * @param {Function} [onComplete] callback once effect is over
+     * @param {Color|string} color - a CSS color value
+     * @param {number} [duration=1000] - expressed in milliseconds
+     * @param {Function} [onComplete] - callback once effect is over
      * @example
      * // fade the camera to white upon dying, reload the level, and then fade out back
      * me.game.viewport.fadeIn("#fff", 150, function() {
@@ -552,9 +552,9 @@ class Camera2d extends Renderable {
      * fade to the specified color
      * @name fadeIn
      * @memberof Camera2d
-     * @param {Color|string} color a CSS color value
-     * @param {number} [duration=1000] expressed in milliseconds
-     * @param {Function} [onComplete] callback once effect is over
+     * @param {Color|string} color - a CSS color value
+     * @param {number} [duration=1000] - expressed in milliseconds
+     * @param {Function} [onComplete] - callback once effect is over
      * @example
      * // flash the camera to white for 75ms
      * me.game.viewport.fadeIn("#FFFFFF", 75);
@@ -574,7 +574,7 @@ class Camera2d extends Renderable {
      * set the camera position around the specified object
      * @name focusOn
      * @memberof Camera2d
-     * @param {Renderable} target the renderable to focus the camera on
+     * @param {Renderable} target - the renderable to focus the camera on
      */
     focusOn(target) {
         var bounds = target.getBounds();
@@ -588,8 +588,8 @@ class Camera2d extends Renderable {
      * check if the specified renderable is in the camera
      * @name isVisible
      * @memberof Camera2d
-     * @param {Renderable} obj to be checked against
-     * @param {boolean} [floating = obj.floating] if visibility check should be done against screen coordinates
+     * @param {Renderable} obj - to be checked against
+     * @param {boolean} [floating = obj.floating] - if visibility check should be done against screen coordinates
      * @returns {boolean}
      */
     isVisible(obj, floating = obj.floating) {
@@ -608,7 +608,7 @@ class Camera2d extends Renderable {
      * @memberof Camera2d
      * @param {number} x
      * @param {number} y
-     * @param {number} [v] an optional vector object where to set the
+     * @param {number} [v] - an optional vector object where to set the
      * converted value
      * @returns {Vector2d}
      */
@@ -628,7 +628,7 @@ class Camera2d extends Renderable {
      * @memberof Camera2d
      * @param {number} x
      * @param {number} y
-     * @param {number} [v] an optional vector object where to set the
+     * @param {number} [v] - an optional vector object where to set the
      * converted value
      * @returns {Vector2d}
      */

package/src/entity/entity.js

@@ -12,21 +12,21 @@ import Body from "./../physics/body.js";
  */
 class Entity extends Renderable {
     /**
-     * @param {number} x the x coordinates of the entity object
-     * @param {number} y the y coordinates of the entity object
-     * @param {object} settings Entity properties, to be defined through Tiled or when calling the entity constructor
+     * @param {number} x - the x coordinates of the entity object
+     * @param {number} y - the y coordinates of the entity object
+     * @param {object} settings - Entity properties, to be defined through Tiled or when calling the entity constructor
      * <img src="images/object_properties.png"/>
-     * @param {number} settings.width the physical width the entity takes up in game
-     * @param {number} settings.height the physical height the entity takes up in game
-     * @param {string} [settings.name] object entity name
-     * @param {string} [settings.id] object unique IDs
-     * @param {Image|string} [settings.image] resource name of a spritesheet to use for the entity renderable component
-     * @param {Vector2d} [settings.anchorPoint=0.0] Entity anchor point
-     * @param {number} [settings.framewidth=settings.width] width of a single frame in the given spritesheet
-     * @param {number} [settings.frameheight=settings.width] height of a single frame in the given spritesheet
-     * @param {string} [settings.type] object type
-     * @param {number} [settings.collisionMask] Mask collision detection for this object
-     * @param {Rect[]|Polygon[]|Line[]|Ellipse[]} [settings.shapes] the initial list of collision shapes (usually populated through Tiled)
+     * @param {number} settings.width - the physical width the entity takes up in game
+     * @param {number} settings.height - the physical height the entity takes up in game
+     * @param {string} [settings.name] - object entity name
+     * @param {string} [settings.id] - object unique IDs
+     * @param {Image|string} [settings.image] - resource name of a spritesheet to use for the entity renderable component
+     * @param {Vector2d} [settings.anchorPoint=0.0] - Entity anchor point
+     * @param {number} [settings.framewidth=settings.width] - width of a single frame in the given spritesheet
+     * @param {number} [settings.frameheight=settings.width] - height of a single frame in the given spritesheet
+     * @param {string} [settings.type] - object type
+     * @param {number} [settings.collisionMask] - Mask collision detection for this object
+     * @param {Rect[]|Polygon[]|Line[]|Ellipse[]} [settings.shapes] - the initial list of collision shapes (usually populated through Tiled)
      */
     constructor(x, y, settings) {
 
@@ -158,7 +158,7 @@ class Entity extends Renderable {
      * @ignore
      * @name onBodyUpdate
      * @memberof Entity
-     * @param {Body} body the body whose bounds to update
+     * @param {Body} body - the body whose bounds to update
      */
     onBodyUpdate(body) {
         // update the entity bounds to include the body bounds
@@ -192,8 +192,8 @@ class Entity extends Renderable {
      * @name draw
      * @memberof Entity
      * @protected
-     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer instance
-     * @param {Camera2d} [viewport] the viewport to (re)draw
+     * @param {CanvasRenderer|WebGLRenderer} renderer - a renderer instance
+     * @param {Camera2d} [viewport] - the viewport to (re)draw
      */
     draw(renderer, viewport) {
         var renderable = this.renderable;

package/src/geometries/ellipse.js

@@ -6,10 +6,10 @@ import pool from "./../system/pooling.js";
  */
 class Ellipse {
     /**
-     * @param {number} x the center x coordinate of the ellipse
-     * @param {number} y the center y coordinate of the ellipse
-     * @param {number} w width (diameter) of the ellipse
-     * @param {number} h height (diameter) of the ellipse
+     * @param {number} x - the center x coordinate of the ellipse
+     * @param {number} y - the center y coordinate of the ellipse
+     * @param {number} w - width (diameter) of the ellipse
+     * @param {number} h - height (diameter) of the ellipse
      */
     constructor(x, y, w, h) {
         /**
@@ -77,10 +77,10 @@ class Ellipse {
      * set new value to the Ellipse shape
      * @name setShape
      * @memberof Ellipse
-     * @param {number} x the center x coordinate of the ellipse
-     * @param {number} y the center y coordinate of the ellipse
-     * @param {number} w width (diameter) of the ellipse
-     * @param {number} h height (diameter) of the ellipse
+     * @param {number} x - the center x coordinate of the ellipse
+     * @param {number} y - the center y coordinate of the ellipse
+     * @param {number} w - width (diameter) of the ellipse
+     * @param {number} h - height (diameter) of the ellipse
      * @returns {Ellipse} this instance for objecf chaining
      */
     setShape(x, y, w, h) {
@@ -106,8 +106,8 @@ class Ellipse {
      * Rotate this Ellipse (counter-clockwise) by the specified angle (in radians).
      * @name rotate
      * @memberof Ellipse
-     * @param {number} angle The angle to rotate (in radians)
-     * @param {Vector2d|ObservableVector2d} [v] an optional point to rotate around
+     * @param {number} angle - The angle to rotate (in radians)
+     * @param {Vector2d|ObservableVector2d} [v] - an optional point to rotate around
      * @returns {Ellipse} Reference to this object for method chaining
      */
     rotate(angle, v) {
@@ -151,7 +151,7 @@ class Ellipse {
      * apply the given transformation matrix to this ellipse
      * @name transform
      * @memberof Ellipse
-     * @param {Matrix2d} matrix the transformation matrix
+     * @param {Matrix2d} matrix - the transformation matrix
      * @returns {Polygon} Reference to this object for method chaining
      */
     transform(matrix) { // eslint-disable-line no-unused-vars
@@ -164,15 +164,15 @@ class Ellipse {
      * @name translate
      * @memberof Ellipse
      * @method
-     * @param {number} x x offset
-     * @param {number} y y offset
+     * @param {number} x - x offset
+     * @param {number} y - y offset
      * @returns {Ellipse} this ellipse
      */
     /**
      * translate the circle/ellipse by the specified vector
      * @name translate
      * @memberof Ellipse
-     * @param {Vector2d} v vector offset
+     * @param {Vector2d} v - vector offset
      * @returns {Ellipse} this ellipse
      */
     translate() {
@@ -208,8 +208,8 @@ class Ellipse {
      * check if this circle/ellipse contains the specified point
      * @name contains
      * @memberof Ellipse
-     * @param  {number} x x coordinate
-     * @param  {number} y y coordinate
+     * @param  {number} x -  x coordinate
+     * @param  {number} y -  y coordinate
      * @returns {boolean} true if contains
      */
     contains() {

package/src/geometries/line.js

@@ -5,9 +5,9 @@ import Polygon from "./poly.js";
  * @classdesc
  * a line segment Object
  * @augments Polygon
- * @param {number} x origin point of the Line
- * @param {number} y origin point of the Line
- * @param {Vector2d[]} points array of vectors defining the Line
+ * @param {number} x - origin point of the Line
+ * @param {number} y - origin point of the Line
+ * @param {Vector2d[]} points - array of vectors defining the Line
  */
 
 class Line extends Polygon {
@@ -25,8 +25,8 @@ class Line extends Polygon {
      * Returns true if the Line contains the given point
      * @name contains
      * @memberof Line
-     * @param  {number} x x coordinate
-     * @param  {number} y y coordinate
+     * @param  {number} x -  x coordinate
+     * @param  {number} y -  y coordinate
      * @returns {boolean} true if contains
      */
     contains() {