melonjs 14.0.2 → 14.1.1

package/src/geometries/path2d.js

@@ -6,7 +6,7 @@ import earcut from "earcut";
  * @classdesc
  * a simplified path2d implementation, supporting only one path
  */
-class Path2D {
+ export default class Path2D {
     constructor() {
         /**
          * the points defining the current path
@@ -92,8 +92,8 @@ class Path2D {
      * moves the starting point of the current path to the (x, y) coordinates.
      * @name moveTo
      * @memberof Path2D
-     * @param {number} x the x-axis (horizontal) coordinate of the point.
-     * @param {number} y the y-axis (vertical) coordinate of the point.
+     * @param {number} x - the x-axis (horizontal) coordinate of the point.
+     * @param {number} y - the y-axis (vertical) coordinate of the point.
      */
     moveTo(x, y) {
       this.points.push(pool.pull("Vector2d", x, y));
@@ -103,8 +103,8 @@ class Path2D {
      * connects the last point in the current patch to the (x, y) coordinates with a straight line.
      * @name lineTo
      * @memberof Path2D
-     * @param {number} x the x-axis coordinate of the line's end point.
-     * @param {number} y the y-axis coordinate of the line's end point.
+     * @param {number} x - the x-axis coordinate of the line's end point.
+     * @param {number} y - the y-axis coordinate of the line's end point.
      */
     lineTo(x, y) {
         this.points.push(pool.pull("Vector2d", x, y));
@@ -115,12 +115,12 @@ class Path2D {
      * starting at startAngle and ending at endAngle going in the given direction by counterclockwise (defaulting to clockwise).
      * @name arc
      * @memberof Path2D
-     * @param {number} x the horizontal coordinate of the arc's center.
-     * @param {number} y the vertical coordinate of the arc's center.
-     * @param {number} radius the arc's radius. Must be positive.
-     * @param {number} startAngle the angle at which the arc starts in radians, measured from the positive x-axis.
-     * @param {number} endAngle the angle at which the arc ends in radians, measured from the positive x-axis.
-     * @param {boolean} [anticlockwise=false] an optional boolean value. If true, draws the arc counter-clockwise between the start and end angles.
+     * @param {number} x - the horizontal coordinate of the arc's center.
+     * @param {number} y - the vertical coordinate of the arc's center.
+     * @param {number} radius - the arc's radius. Must be positive.
+     * @param {number} startAngle - the angle at which the arc starts in radians, measured from the positive x-axis.
+     * @param {number} endAngle - the angle at which the arc ends in radians, measured from the positive x-axis.
+     * @param {boolean} [anticlockwise=false] - an optional boolean value. If true, draws the arc counter-clockwise between the start and end angles.
      */
     arc(x, y, radius, startAngle, endAngle, anticlockwise = false) {
         var points = this.points;
@@ -164,11 +164,11 @@ class Path2D {
      * adds a circular arc to the path with the given control points and radius, connected to the previous point by a straight line.
      * @name arcTo
      * @memberof Path2D
-     * @param {number} x1 the x-axis coordinate of the first control point.
-     * @param {number} y1 the y-axis coordinate of the first control point.
-     * @param {number} x2 the x-axis coordinate of the second control point.
-     * @param {number} y2 the y-axis coordinate of the second control point.
-     * @param {number} radius the arc's radius. Must be positive.
+     * @param {number} x1 - the x-axis coordinate of the first control point.
+     * @param {number} y1 - the y-axis coordinate of the first control point.
+     * @param {number} x2 - the x-axis coordinate of the second control point.
+     * @param {number} y2 - the y-axis coordinate of the second control point.
+     * @param {number} radius - the arc's radius. Must be positive.
      */
     arcTo(x1, y1, x2, y2, radius) {
         var points = this.points;
@@ -212,14 +212,14 @@ class Path2D {
      * starting at startAngle and ending at endAngle going in the given direction by counterclockwise.
      * @name ellipse
      * @memberof Path2D
-     * @param {number} x the x-axis (horizontal) coordinate of the ellipse's center.
-     * @param {number} y the  y-axis (vertical) coordinate of the ellipse's center.
-     * @param {number} radiusX the ellipse's major-axis radius. Must be non-negative.
-     * @param {number} radiusY the ellipse's minor-axis radius. Must be non-negative.
-     * @param {number} rotation the rotation of the ellipse, expressed in radians.
-     * @param {number} startAngle the angle at which the ellipse starts, measured clockwise from the positive x-axis and expressed in radians.
-     * @param {number} endAngle the angle at which the ellipse ends, measured clockwise from the positive x-axis and expressed in radians.
-     * @param {boolean} [anticlockwise=false] an optional boolean value which, if true, draws the ellipse counterclockwise (anticlockwise).
+     * @param {number} x - the x-axis (horizontal) coordinate of the ellipse's center.
+     * @param {number} y - the  y-axis (vertical) coordinate of the ellipse's center.
+     * @param {number} radiusX - the ellipse's major-axis radius. Must be non-negative.
+     * @param {number} radiusY - the ellipse's minor-axis radius. Must be non-negative.
+     * @param {number} rotation - the rotation of the ellipse, expressed in radians.
+     * @param {number} startAngle - the angle at which the ellipse starts, measured clockwise from the positive x-axis and expressed in radians.
+     * @param {number} endAngle - the angle at which the ellipse ends, measured clockwise from the positive x-axis and expressed in radians.
+     * @param {boolean} [anticlockwise=false] - an optional boolean value which, if true, draws the ellipse counterclockwise (anticlockwise).
      */
     ellipse(x, y, radiusX, radiusY, rotation, startAngle, endAngle, anticlockwise = false) {
         var points = this.points;
@@ -271,10 +271,10 @@ class Path2D {
      * creates a path for a rectangle at position (x, y) with a size that is determined by width and height.
      * @name rect
      * @memberof Path2D
-     * @param {number} x the x-axis coordinate of the rectangle's starting point.
-     * @param {number} y the y-axis coordinate of the rectangle's starting point.
-     * @param {number} width the rectangle's width. Positive values are to the right, and negative to the left.
-     * @param {number} height the rectangle's height. Positive values are down, and negative are up.
+     * @param {number} x - the x-axis coordinate of the rectangle's starting point.
+     * @param {number} y - the y-axis coordinate of the rectangle's starting point.
+     * @param {number} width - the rectangle's width. Positive values are to the right, and negative to the left.
+     * @param {number} height - the rectangle's height. Positive values are down, and negative are up.
      */
     rect(x, y, width, height) {
         this.moveTo(x, y);
@@ -288,11 +288,11 @@ class Path2D {
      * adds an rounded rectangle to the current path.
      * @name roundRect
      * @memberof Path2D
-     * @param {number} x the x-axis coordinate of the rectangle's starting point.
-     * @param {number} y the y-axis coordinate of the rectangle's starting point.
-     * @param {number} width the rectangle's width. Positive values are to the right, and negative to the left.
-     * @param {number} height the rectangle's height. Positive values are down, and negative are up.
-     * @param {number} radius the arc's radius to draw the borders. Must be positive.
+     * @param {number} x - the x-axis coordinate of the rectangle's starting point.
+     * @param {number} y - the y-axis coordinate of the rectangle's starting point.
+     * @param {number} width - the rectangle's width. Positive values are to the right, and negative to the left.
+     * @param {number} height - the rectangle's height. Positive values are down, and negative are up.
+     * @param {number} radius - the arc's radius to draw the borders. Must be positive.
      */
      roundRect(x, y, width, height, radius) {
         this.moveTo(x + radius, y);
@@ -306,4 +306,3 @@ class Path2D {
         this.arcTo(x, y, x + radius, y, radius);
     }
 }
-export default Path2D;

package/src/geometries/point.js

@@ -2,7 +2,7 @@
  * @classdesc
  * represents a point in a 2d space
  */
-class Point {
+ export default class Point {
     constructor(x = 0, y = 0) {
         /**
          * the position of the point on the horizontal axis
@@ -77,4 +77,3 @@ class Point {
         return new Point(this.x, this.y);
     }
 }
-export default Point;

package/src/geometries/poly.js

@@ -12,11 +12,11 @@ import pool from "./../system/pooling.js";
  *
  * A polygon's `winding` is clockwise if its vertices (points) are declared turning to the right. The image above shows COUNTERCLOCKWISE winding.
  */
-class Polygon {
+ export default class Polygon {
     /**
-     * @param {number} x origin point of the Polygon
-     * @param {number} y origin point of the Polygon
-     * @param {Vector2d[]} points array of vector defining the Polygon
+     * @param {number} x - origin point of the Polygon
+     * @param {number} y - origin point of the Polygon
+     * @param {Vector2d[]} points - array of vector defining the Polygon
      */
     constructor(x, y, points) {
         /**
@@ -83,9 +83,9 @@ class Polygon {
      * set new value to the Polygon
      * @name setShape
      * @memberof Polygon
-     * @param {number} x position of the Polygon
-     * @param {number} y position of the Polygon
-     * @param {Vector2d[]|number[]} points array of vector or vertice defining the Polygon
+     * @param {number} x - position of the Polygon
+     * @param {number} y - position of the Polygon
+     * @param {Vector2d[]|number[]} points - array of vector or vertice defining the Polygon
      * @returns {Polygon} this instance for objecf chaining
      */
     setShape(x, y, points) {
@@ -98,7 +98,7 @@ class Polygon {
      * set the vertices defining this Polygon
      * @name setVertices
      * @memberof Polygon
-     * @param {Vector2d[]} vertices array of vector or vertice defining the Polygon
+     * @param {Vector2d[]} vertices - array of vector or vertice defining the Polygon
      * @returns {Polygon} this instance for objecf chaining
      */
     setVertices(vertices) {
@@ -137,7 +137,7 @@ class Polygon {
      * apply the given transformation matrix to this Polygon
      * @name transform
      * @memberof Polygon
-     * @param {Matrix2d} m the transformation matrix
+     * @param {Matrix2d} m - the transformation matrix
      * @returns {Polygon} Reference to this object for method chaining
      */
     transform(m) {
@@ -175,8 +175,8 @@ class Polygon {
      * Rotate this Polygon (counter-clockwise) by the specified angle (in radians).
      * @name rotate
      * @memberof Polygon
-     * @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 {Polygon} Reference to this object for method chaining
      */
     rotate(angle, v) {
@@ -332,15 +332,15 @@ class Polygon {
      * @name translate
      * @memberof Polygon
      * @method
-     * @param {number} x x offset
-     * @param {number} y y offset
+     * @param {number} x - x offset
+     * @param {number} y - y offset
      * @returns {Polygon} this Polygon
      */
     /**
      * translate the Polygon by the specified vector
      * @name translate
      * @memberof Polygon
-     * @param {Vector2d} v vector offset
+     * @param {Vector2d} v - vector offset
      * @returns {Polygon} Reference to this object for method chaining
      */
     translate() {
@@ -410,8 +410,8 @@ class Polygon {
      *  bounding rect, as the function can be highly consuming with complex shapes)
      * @name contains
      * @memberof Polygon
-     * @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() {
@@ -486,5 +486,3 @@ class Polygon {
         return new Polygon(this.pos.x, this.pos.y, copy);
     }
 }
-
-export default Polygon;

package/src/geometries/rectangle.js

@@ -6,12 +6,12 @@ import Polygon from "./poly.js";
  * a rectangle Object
  * @augments Polygon
  */
-class Rect extends Polygon {
+ export default class Rect extends Polygon {
     /**
-     * @param {number} x position of the Rectangle
-     * @param {number} y position of the Rectangle
-     * @param {number} w width of the rectangle
-     * @param {number} h height of the rectangle
+     * @param {number} x - position of the Rectangle
+     * @param {number} y - position of the Rectangle
+     * @param {number} w - width of the rectangle
+     * @param {number} h - height of the rectangle
      */
     constructor(x, y, w, h) {
         // parent constructor
@@ -33,10 +33,10 @@ class Rect extends Polygon {
      * set new value to the rectangle shape
      * @name setShape
      * @memberof Rect
-     * @param {number} x position of the Rectangle
-     * @param {number} y position of the Rectangle
-     * @param {number|Vector2d[]} w width of the rectangle, or an array of vector defining the rectangle
-     * @param {number} [h] height of the rectangle, if a numeral width parameter is specified
+     * @param {number} x - position of the Rectangle
+     * @param {number} y - position of the Rectangle
+     * @param {number|Vector2d[]} w - width of the rectangle, or an array of vector defining the rectangle
+     * @param {number} [h] - height of the rectangle, if a numeral width parameter is specified
      * @returns {Rect} this rectangle
      */
     setShape(x, y, w, h) {
@@ -175,8 +175,8 @@ class Rect extends Polygon {
      * center the rectangle position around the given coordinates
      * @name centerOn
      * @memberof Rect
-     * @param {number} x the x coordinate around which to center this rectangle
-     * @param {number} y the y coordinate around which to center this rectangle
+     * @param {number} x - the x coordinate around which to center this rectangle
+     * @param {number} y - the y coordinate around which to center this rectangle
      * @returns {Rect} this rectangle
      */
     centerOn(x, y) {
@@ -189,8 +189,8 @@ class Rect extends Polygon {
      * resize the rectangle
      * @name resize
      * @memberof Rect
-     * @param {number} w new width of the rectangle
-     * @param {number} h new height of the rectangle
+     * @param {number} w - new width of the rectangle
+     * @param {number} h - new height of the rectangle
      * @returns {Rect} this rectangle
      */
     resize(w, h) {
@@ -203,8 +203,8 @@ class Rect extends Polygon {
      * scale the rectangle
      * @name scale
      * @memberof Rect
-     * @param {number} x a number representing the abscissa of the scaling vector.
-     * @param {number} [y=x] a number representing the ordinate of the scaling vector.
+     * @param {number} x - a number representing the abscissa of the scaling vector.
+     * @param {number} [y=x] - a number representing the ordinate of the scaling vector.
      * @returns {Rect} this rectangle
      */
     scale(x, y = x) {
@@ -227,7 +227,7 @@ class Rect extends Polygon {
      * copy the position and size of the given rectangle into this one
      * @name copy
      * @memberof Rect
-     * @param {Rect} rect Source rectangle
+     * @param {Rect} rect - Source rectangle
      * @returns {Rect} new rectangle
      */
     copy(rect) {
@@ -238,7 +238,7 @@ class Rect extends Polygon {
      * merge this rectangle with another one
      * @name union
      * @memberof Rect
-     * @param {Rect} rect other rectangle to union with
+     * @param {Rect} rect - other rectangle to union with
      * @returns {Rect} the union(ed) rectangle
      */
     union(rect) {
@@ -285,8 +285,8 @@ class Rect extends Polygon {
      * @name contains
      * @memberof Rect
      * @method
-     * @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
      */
 
@@ -363,4 +363,3 @@ class Rect extends Polygon {
         );
     }
 }
-export default Rect;

package/src/geometries/roundrect.js

@@ -7,13 +7,13 @@ import Rect from "./rectangle.js";
  * a rectangle object with rounded corners
  * @augments Rect
  */
-class RoundRect extends Rect {
+export default class RoundRect extends Rect {
     /**
-     * @param {number} x position of the rounded rectangle
-     * @param {number} y position of the rounded rectangle
-     * @param {number} width the rectangle width
-     * @param {number} height the rectangle height
-     * @param {number} [radius=20] the radius of the rounded corner
+     * @param {number} x - position of the rounded rectangle
+     * @param {number} y - position of the rounded rectangle
+     * @param {number} width - the rectangle width
+     * @param {number} height - the rectangle height
+     * @param {number} [radius=20] - the radius of the rounded corner
      */
     constructor(x, y, width, height, radius = 20) {
         // parent constructor
@@ -56,7 +56,7 @@ class RoundRect extends Rect {
      * copy the position, size and radius of the given rounded rectangle into this one
      * @name copy
      * @memberof RoundRect
-     * @param {RoundRect} rrect source rounded rectangle
+     * @param {RoundRect} rrect - source rounded rectangle
      * @returns {RoundRect} new rectangle
      */
     copy(rrect) {
@@ -70,8 +70,8 @@ class RoundRect extends Rect {
      * @name contains
      * @memberof RoundRect
      * @method
-     * @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
      */
 
@@ -156,4 +156,3 @@ class RoundRect extends Rect {
         return new RoundRect(this.pos.x, this.pos.y, this.width, this.height, this.radius);
     }
 }
-export default RoundRect;

package/src/input/gamepad.js

@@ -355,12 +355,12 @@ export var GAMEPAD = {
  * @name bindGamepad
  * @memberof input
  * @public
- * @param {number} index Gamepad index
- * @param {object} button Button/Axis definition
- * @param {string} button.type "buttons" or "axes"
- * @param {number} button.code button or axis code id (See {@link input.GAMEPAD.BUTTONS}, {@link input.GAMEPAD.AXES})
- * @param {number} [button.threshold=1] value indicating when the axis should trigger the keycode (e.g. -0.5 or 0.5)
- * @param {number} keyCode (See {@link input.KEY})
+ * @param {number} index - Gamepad index
+ * @param {object} button - Button/Axis definition
+ * @param {string} button.type - "buttons" or "axes"
+ * @param {number} button.code - button or axis code id (See {@link input.GAMEPAD.BUTTONS}, {@link input.GAMEPAD.AXES})
+ * @param {number} [button.threshold=1] - value indicating when the axis should trigger the keycode (e.g. -0.5 or 0.5)
+ * @param {number} keyCode - (See {@link input.KEY})
  * @example
  * // enable the keyboard
  * me.input.bindKey(me.input.KEY.X, "shoot");
@@ -429,8 +429,8 @@ export function bindGamepad(index, button, keyCode) {
  * @name unbindGamepad
  * @memberof input
  * @public
- * @param {number} index Gamepad index
- * @param {number} button (See {@link input.GAMEPAD.BUTTONS})
+ * @param {number} index - Gamepad index
+ * @param {number} button - (See {@link input.GAMEPAD.BUTTONS})
  * @example
  * me.input.unbindGamepad(0, me.input.GAMEPAD.BUTTONS.FACE_1);
  */
@@ -447,7 +447,7 @@ export function unbindGamepad(index, button) {
  * @name setGamepadDeadzone
  * @memberof input
  * @public
- * @param {number} value Deadzone value
+ * @param {number} value - Deadzone value
  */
 export function setGamepadDeadzone(value) {
     deadzone = value;
@@ -460,12 +460,12 @@ export function setGamepadDeadzone(value) {
  * @name setGamepadMapping
  * @memberof input
  * @public
- * @param {string} id Gamepad id string
- * @param {object} mapping A hash table
- * @param {number[]} mapping.axes Standard analog control stick axis locations
- * @param {number[]} mapping.buttons Standard digital button locations
- * @param {number[]} [mapping.analog] Analog axis locations for buttons
- * @param {Function} [mapping.normalize_fn] a function that returns a normalized value in range [-1.0..1.0] for the given value, axis and button
+ * @param {string} id - Gamepad id string
+ * @param {object} mapping - A hash table
+ * @param {number[]} mapping.axes - Standard analog control stick axis locations
+ * @param {number[]} mapping.buttons - Standard digital button locations
+ * @param {number[]} [mapping.analog] - Analog axis locations for buttons
+ * @param {Function} [mapping.normalize_fn] - a function that returns a normalized value in range [-1.0..1.0] for the given value, axis and button
  * @example
  * // A weird controller that has its axis mappings reversed
  * me.input.setGamepadMapping("Generic USB Controller", {

package/src/input/keyboard.js

@@ -331,7 +331,7 @@ export function initKeyboardEvent() {
  * @name isKeyPressed
  * @memberof input
  * @public
- * @param {string} action user defined corresponding action
+ * @param {string} action - user defined corresponding action
  * @returns {boolean} true if pressed
  * @example
  * if (me.input.isKeyPressed('left')) {
@@ -356,7 +356,7 @@ export function isKeyPressed(action) {
  * @name keyStatus
  * @memberof input
  * @public
- * @param {string} action user defined corresponding action
+ * @param {string} action - user defined corresponding action
  * @returns {boolean} down (true) or up(false)
  */
 export function keyStatus(action) {
@@ -369,9 +369,9 @@ export function keyStatus(action) {
  * @name triggerKeyEvent
  * @memberof input
  * @public
- * @param {number} keycode (See {@link input.KEY})
- * @param {boolean} [status=false] true to trigger a key down event, or false for key up event
- * @param {number} [mouseButton] the mouse button to trigger
+ * @param {number} keycode - (See {@link input.KEY})
+ * @param {boolean} [status=false] - true to trigger a key down event, or false for key up event
+ * @param {number} [mouseButton] - the mouse button to trigger
  * @example
  * // trigger a key press
  * me.input.triggerKeyEvent(me.input.KEY.LEFT, true);
@@ -391,10 +391,10 @@ export function triggerKeyEvent(keycode, status, mouseButton) {
  * @name bindKey
  * @memberof input
  * @public
- * @param {number} keycode (See {@link input.KEY})
- * @param {string} action user defined corresponding action
- * @param {boolean} [lock=false] cancel the keypress event once read
- * @param {boolean} [preventDefault=input.preventDefault] prevent default browser action
+ * @param {number} keycode - (See {@link input.KEY})
+ * @param {string} action - user defined corresponding action
+ * @param {boolean} [lock=false] - cancel the keypress event once read
+ * @param {boolean} [preventDefault=input.preventDefault] - prevent default browser action
  * @example
  * // enable the keyboard
  * me.input.bindKey(me.input.KEY.LEFT,  "left");
@@ -417,7 +417,7 @@ export function bindKey(keycode, action, lock, preventDefault = preventDefaultAc
  * @name getBindingKey
  * @memberof input
  * @public
- * @param {number} keycode (See {@link input.KEY})
+ * @param {number} keycode - (See {@link input.KEY})
  * @returns {string} user defined associated action
  */
 export function getBindingKey(keycode) {
@@ -429,7 +429,7 @@ export function getBindingKey(keycode) {
  * @name unlockKey
  * @memberof input
  * @public
- * @param {string} action user defined corresponding action
+ * @param {string} action - user defined corresponding action
  * @example
  * // Unlock jump when touching the ground
  * if (!this.falling && !this.jumping) {
@@ -445,7 +445,7 @@ export function unlockKey(action) {
  * @name unbindKey
  * @memberof input
  * @public
- * @param {number} keycode (See {@link input.KEY})
+ * @param {number} keycode - (See {@link input.KEY})
  * @example
  * me.input.unbindKey(me.input.KEY.LEFT);
  */

package/src/input/pointer.js

@@ -310,12 +310,12 @@ class Pointer extends Bounds {
      * initialize the Pointer object using the given Event Object
      * @name Pointer#set
      * @private
-     * @param {Event} event the original Event object
-     * @param {number} [pageX=0] the horizontal coordinate at which the event occurred, relative to the left edge of the entire document
-     * @param {number} [pageY=0] the vertical coordinate at which the event occurred, relative to the left edge of the entire document
-     * @param {number} [clientX=0] the horizontal coordinate within the application's client area at which the event occurred
-     * @param {number} [clientY=0] the vertical coordinate within the application's client area at which the event occurred
-     * @param {number} [pointerId=1] the Pointer, Touch or Mouse event Id (1)
+     * @param {Event} event - the original Event object
+     * @param {number} [pageX=0] - the horizontal coordinate at which the event occurred, relative to the left edge of the entire document
+     * @param {number} [pageY=0] - the vertical coordinate at which the event occurred, relative to the left edge of the entire document
+     * @param {number} [clientX=0] - the horizontal coordinate within the application's client area at which the event occurred
+     * @param {number} [clientY=0] - the vertical coordinate within the application's client area at which the event occurred
+     * @param {number} [pointerId=1] - the Pointer, Touch or Mouse event Id (1)
      */
     setEvent(event, pageX = 0, pageY = 0, clientX = 0, clientY = 0, pointerId = 1) {
         // the original event object

package/src/input/pointerevent.js

@@ -543,9 +543,9 @@ export var throttlingInterval;
  * @name globalToLocal
  * @memberof input
  * @public
- * @param {number} x the global x coordinate to be translated.
- * @param {number} y the global y coordinate to be translated.
- * @param {Vector2d} [v] an optional vector object where to set the translated coordinates
+ * @param {number} x - the global x coordinate to be translated.
+ * @param {number} y - the global y coordinate to be translated.
+ * @param {Vector2d} [v] - an optional vector object where to set the translated coordinates
  * @returns {Vector2d} A vector object with the corresponding translated coordinates
  * @example
  * onMouseEvent : function (pointer) {
@@ -590,7 +590,7 @@ export function setTouchAction(element, value) {
  * @name bindPointer
  * @memberof input
  * @public
- * @param {number} [button=input.pointer.LEFT] (accordingly to W3C values : 0,1,2 for left, middle and right buttons)
+ * @param {number} [button=input.pointer.LEFT] - (accordingly to W3C values : 0,1,2 for left, middle and right buttons)
  * @param {input.KEY} keyCode
  * @example
  * // enable the keyboard
@@ -620,7 +620,7 @@ export function bindPointer() {
  * @name unbindPointer
  * @memberof input
  * @public
- * @param {number} [button=input.pointer.LEFT] (accordingly to W3C values : 0,1,2 for left, middle and right buttons)
+ * @param {number} [button=input.pointer.LEFT] - (accordingly to W3C values : 0,1,2 for left, middle and right buttons)
  * @example
  * me.input.unbindPointer(me.input.pointer.LEFT);
  */
@@ -641,7 +641,7 @@ export function unbindPointer(button) {
  * @name registerPointerEvent
  * @memberof input
  * @public
- * @param {string} eventType The event type for which the object is registering <br>
+ * @param {string} eventType - The event type for which the object is registering <br>
  * melonJS currently supports: <br>
  * <ul>
  *   <li><code>"pointermove"</code></li>
@@ -653,8 +653,8 @@ export function unbindPointer(button) {
  *   <li><code>"pointercancel"</code></li>
  *   <li><code>"wheel"</code></li>
  * </ul>
- * @param {Rect|Polygon|Line|Ellipse} region a shape representing the region to register on
- * @param {Function} callback methods to be called when the event occurs.
+ * @param {Rect|Polygon|Line|Ellipse} region - a shape representing the region to register on
+ * @param {Function} callback - methods to be called when the event occurs.
  * Returning `false` from the defined callback will prevent the event to be propagated to other objects
  * @example
  *  // onActivate function
@@ -712,9 +712,9 @@ export function registerPointerEvent(eventType, region, callback) {
  * @name releasePointerEvent
  * @memberof input
  * @public
- * @param {string} eventType The event type for which the object was registered. See {@link input.registerPointerEvent}
- * @param {Rect|Polygon|Line|Ellipse} region the registered region to release for this event
- * @param {Function} [callback="all"] if specified unregister the event only for the specific callback
+ * @param {string} eventType - The event type for which the object was registered. See {@link input.registerPointerEvent}
+ * @param {Rect|Polygon|Line|Ellipse} region - the registered region to release for this event
+ * @param {Function} [callback="all"] - if specified unregister the event only for the specific callback
  * @example
  * // release the registered region on the 'pointerdown' event
  * me.input.releasePointerEvent('pointerdown', this);
@@ -756,7 +756,7 @@ export function releasePointerEvent(eventType, region, callback) {
  * @name releaseAllPointerEvents
  * @memberof input
  * @public
- * @param {Rect|Polygon|Line|Ellipse} region the registered region to release event from
+ * @param {Rect|Polygon|Line|Ellipse} region - the registered region to release event from
  * @example
  * // release all registered event on the
  * me.input.releaseAllPointerEvents(this);

package/src/lang/deprecated.js

@@ -9,9 +9,9 @@ import UISpriteElement from "./../renderable/ui/uispriteelement.js";
 /**
  * display a deprecation warning in the console
  * @ignore
- * @param {string} deprecated deprecated class,function or property name
- * @param {string} replacement the replacement class, function, or property name
- * @param {string} version the version since when the lass,function or property is deprecated
+ * @param {string} deprecated - deprecated class,function or property name
+ * @param {string} replacement - the replacement class, function, or property name
+ * @param {string} version - the version since when the lass,function or property is deprecated
  */
 export function warning(deprecated, replacement, version) {
     var msg = "melonJS: %s is deprecated since version %s, please use %s";
@@ -71,9 +71,9 @@ Object.defineProperty(Renderer.prototype, "Texture", {
  */
 export class DraggableEntity extends Draggable {
     /**
-     * @param {number} x the x coordinates of the draggable object
-     * @param {number} y the y coordinates of the draggable object
-     * @param {object} settings Entity properties (see {@link Entity})
+     * @param {number} x - the x coordinates of the draggable object
+     * @param {number} y - the y coordinates of the draggable object
+     * @param {object} settings - Entity properties (see {@link Entity})
      */
     constructor(x, y, settings) {
         warning("DraggableEntity", "Draggable", "10.5.0");
@@ -90,9 +90,9 @@ export class DraggableEntity extends Draggable {
  */
 export class DroptargetEntity extends DropTarget {
     /**
-     * @param {number} x the x coordinates of the draggable object
-     * @param {number} y the y coordinates of the draggable object
-     * @param {object} settings Entity properties (see {@link Entity})
+     * @param {number} x - the x coordinates of the draggable object
+     * @param {number} y - the y coordinates of the draggable object
+     * @param {object} settings - Entity properties (see {@link Entity})
      */
     constructor(x, y, settings) {
         warning("DroptargetEntity", "DropTarget", "10.5.0");
@@ -136,9 +136,9 @@ Renderer.prototype.getScreenContext = function()  {
  */
  export class GUI_Object extends UISpriteElement {
     /**
-     * @param {number} x the x coordinate of the GUI Object
-     * @param {number} y the y coordinate of the GUI Object
-     * @param {object} settings See {@link Sprite}
+     * @param {number} x - the x coordinate of the GUI Object
+     * @param {number} y - the y coordinate of the GUI Object
+     * @param {object} settings - See {@link Sprite}
      */
     constructor(x, y, settings) {
         warning("GUI_Object", "UISpriteElement", "14.0.0");