melonjs 10.2.1 → 10.2.2

package/src/physics/bounds.js

@@ -9,7 +9,7 @@ import Polygon from "./../shapes/poly.js";
  * @constructor
  * @memberOf me
  * @param {me.Vector2d[]} [vertices] an array of me.Vector2d points
- * @return {me.Bounds} A new bounds object
+ * @returns {me.Bounds} A new bounds object
  */
 
 class Bounds {
@@ -49,10 +49,10 @@ class Bounds {
      * @name setMinMax
      * @memberOf me.Bounds
      * @function
-     * @param {Number} minX
-     * @param {Number} minY
-     * @param {Number} maxX
-     * @param {Number} maxY
+     * @param {number} minX
+     * @param {number} minY
+     * @param {number} maxX
+     * @param {number} maxY
      */
     setMinMax(minX, minY, maxX, maxY) {
         this.min.x = minX;
@@ -65,7 +65,7 @@ class Bounds {
     /**
      * x position of the bound
      * @public
-     * @type {Number}
+     * @type {number}
      * @name x
      * @memberOf me.Bounds
      */
@@ -82,7 +82,7 @@ class Bounds {
     /**
      * y position of the bounds
      * @public
-     * @type {Number}
+     * @type {number}
      * @name y
      * @memberOf me.Bounds
      */
@@ -100,7 +100,7 @@ class Bounds {
     /**
      * width of the bounds
      * @public
-     * @type {Number}
+     * @type {number}
      * @name width
      * @memberOf me.Bounds
      */
@@ -115,7 +115,7 @@ class Bounds {
     /**
      * width of the bounds
      * @public
-     * @type {Number}
+     * @type {number}
      * @name width
      * @memberOf me.Bounds
      */
@@ -130,7 +130,7 @@ class Bounds {
     /**
      * left coordinate of the bound
      * @public
-     * @type {Number}
+     * @type {number}
      * @name left
      * @memberOf me.Bounds
      */
@@ -141,7 +141,7 @@ class Bounds {
     /**
      * right coordinate of the bound
      * @public
-     * @type {Number}
+     * @type {number}
      * @name right
      * @memberOf me.Bounds
      */
@@ -152,7 +152,7 @@ class Bounds {
     /**
      * top coordinate of the bound
      * @public
-     * @type {Number}
+     * @type {number}
      * @name top
      * @memberOf me.Bounds
      */
@@ -163,7 +163,7 @@ class Bounds {
     /**
      * bottom coordinate of the bound
      * @public
-     * @type {Number}
+     * @type {number}
      * @name bottom
      * @memberOf me.Bounds
      */
@@ -174,7 +174,7 @@ class Bounds {
     /**
      * center position of the bound on the x axis
      * @public
-     * @type {Number}
+     * @type {number}
      * @name centerX
      * @memberOf me.Bounds
      */
@@ -185,7 +185,7 @@ class Bounds {
     /**
      * center position of the bound on the y axis
      * @public
-     * @type {Number}
+     * @type {number}
      * @name centerY
      * @memberOf me.Bounds
      */
@@ -260,8 +260,8 @@ class Bounds {
      * @name addPoint
      * @memberOf me.Bounds
      * @function
-     * @param {me.Vector2d} vector
-     * @param {me.Matrix2d} [matrix] an optional transform to apply to the given point
+     * @param {me.Vector2d} v
+     * @param {me.Matrix2d} [m] an optional transform to apply to the given point
      */
     addPoint(v, m) {
         if (typeof m !== "undefined") {
@@ -278,11 +278,11 @@ class Bounds {
      * @name addFrame
      * @memberOf me.Bounds
      * @function
-     * @param {Number} x0 - left X coordinates of the quad
-     * @param {Number} y0 - top Y coordinates of the quad
-     * @param {Number} x1 - right X coordinates of the quad
-     * @param {Number} y1 - bottom y coordinates of the quad
-     * @param {me.Matrix2d} [matrix] an optional transform to apply to the given frame coordinates
+     * @param {number} x0 - left X coordinates of the quad
+     * @param {number} y0 - top Y coordinates of the quad
+     * @param {number} x1 - right X coordinates of the quad
+     * @param {number} y1 - bottom y coordinates of the quad
+     * @param {me.Matrix2d} [m] an optional transform to apply to the given frame coordinates
      */
     addFrame(x0, y0, x1, y1, m) {
         var v = me.pool.pull("Vector2d");
@@ -302,16 +302,16 @@ class Bounds {
      * @memberOf me.Bounds
      * @function
      * @param {me.Vector2d} point
-     * @return {boolean} True if the bounds contain the point, otherwise false
+     * @returns {boolean} True if the bounds contain the point, otherwise false
      */
     /**
      * Returns true if the bounds contains the given point.
      * @name contains
      * @memberOf me.Bounds
      * @function
-     * @param {Number} x
-     * @param {Number} y
-     * @return {boolean} True if the bounds contain the point, otherwise false
+     * @param {number} x
+     * @param {number} y
+     * @returns {boolean} True if the bounds contain the point, otherwise false
      */
     contains() {
         var arg0 = arguments[0];
@@ -344,7 +344,7 @@ class Bounds {
      * @memberOf me.Bounds
      * @function
      * @param {me.Bounds|me.Rect} bounds
-     * @return {boolean} True if the bounds overlap, otherwise false
+     * @returns {boolean} True if the bounds overlap, otherwise false
      */
     overlaps(bounds) {
         return !(this.right < bounds.left || this.left > bounds.right ||
@@ -356,7 +356,7 @@ class Bounds {
      * @name isFinite
      * @memberOf me.Bounds
      * @function
-     * @return {boolean} false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
+     * @returns {boolean} false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
      */
     isFinite() {
         return (isFinite(this.min.x) && isFinite(this.max.x) && isFinite(this.min.y) && isFinite(this.max.y));
@@ -374,8 +374,8 @@ class Bounds {
      * @name translate
      * @memberOf me.Bounds
      * @function
-     * @param {Number} x
-     * @param {Number} y
+     * @param {number} x
+     * @param {number} y
      */
     translate() {
         var _x, _y;
@@ -406,8 +406,8 @@ class Bounds {
      * @name shift
      * @memberOf me.Bounds
      * @function
-     * @param {Number} x
-     * @param {Number} y
+     * @param {number} x
+     * @param {number} y
      */
     shift() {
         var _x, _y;
@@ -436,7 +436,7 @@ class Bounds {
      * @name clone
      * @memberOf me.Bounds
      * @function
-     * @return {me.Bounds}
+     * @returns {me.Bounds}
      */
     clone() {
         var bounds = new Bounds();
@@ -449,7 +449,7 @@ class Bounds {
      * @name toPolygon
      * @memberOf me.Bounds
      * @function
-     * @return {me.Polygon} a new Polygon that represents this bounds.
+     * @returns {me.Polygon} a new Polygon that represents this bounds.
      */
     toPolygon () {
         return new Polygon(this.x, this.y, [

package/src/physics/collision.js

@@ -14,7 +14,7 @@ var collision = {
       * @name maxChildren
       * @memberOf me.collision
       * @public
-      * @type {Number}
+      * @type {number}
       * @default 8
       * @see me.game.world.broadphase
       */
@@ -25,27 +25,26 @@ var collision = {
       * @name maxDepth
       * @memberOf me.collision
       * @public
-      * @type {Number}
+      * @type {number}
       * @default 4
       * @see me.game.world.broadphase
-      *
       */
      maxDepth : 4,
 
     /**
      * Enum for collision type values.
-     * @property NO_OBJECT to disable collision check
-     * @property PLAYER_OBJECT
-     * @property NPC_OBJECT
-     * @property ENEMY_OBJECT
-     * @property COLLECTABLE_OBJECT
-     * @property ACTION_OBJECT e.g. doors
-     * @property PROJECTILE_OBJECT e.g. missiles
-     * @property WORLD_SHAPE e.g. walls; for map collision shapes
-     * @property USER user-defined collision types (see example)
-     * @property ALL_OBJECT all of the above (including user-defined types)
+     * @property {number} NO_OBJECT to disable collision check
+     * @property {number} PLAYER_OBJECT playbable characters
+     * @property {number} NPC_OBJECT non playable characters
+     * @property {number} ENEMY_OBJECT enemies objects
+     * @property {number} COLLECTABLE_OBJECT collectable objects
+     * @property {number} ACTION_OBJECT e.g. doors
+     * @property {number} PROJECTILE_OBJECT e.g. missiles
+     * @property {number} WORLD_SHAPE e.g. walls; for map collision shapes
+     * @property {number} USER user-defined collision types (see example)
+     * @property {number} ALL_OBJECT all of the above (including user-defined types)
      * @readonly
-     * @enum {Number}
+     * @enum {number}
      * @name types
      * @memberOf me.collision
      * @see me.body.setCollisionMask
@@ -112,7 +111,7 @@ var collision = {
      * @function
      * @param {me.Line} line line to be tested for collision
      * @param {Array.<me.Renderable>} [result] a user defined array that will be populated with intersecting physic objects.
-     * @return {Array.<me.Renderable>} an array of intersecting physic objects
+     * @returns {Array.<me.Renderable>} an array of intersecting physic objects
      * @example
      *    // define a line accross the viewport
      *    var ray = new me.Line(
@@ -131,7 +130,7 @@ var collision = {
      *        // ...
      *    }
      */
-    rayCast(line, resultArray) { return rayCast(line, resultArray); }
+    rayCast(line, result) { return rayCast(line, result); }
 };
 
 export default collision;

package/src/physics/detector.js

@@ -22,7 +22,7 @@ var dummyObj = {
  * @function
  * @param {me.Renderable} a a reference to the object A.
  * @param {me.Renderable} b a reference to the object B.
- * @return {Boolean} true if they should collide, false otherwise
+ * @returns {boolean} true if they should collide, false otherwise
  */
 function shouldCollide(a, b) {
     return (
@@ -38,13 +38,13 @@ function shouldCollide(a, b) {
  * An object representing the result of an intersection.
  * @property {me.Renderable} a The first object participating in the intersection
  * @property {me.Renderable} b The second object participating in the intersection
- * @property {Number} overlap Magnitude of the overlap on the shortest colliding axis
+ * @property {number} overlap Magnitude of the overlap on the shortest colliding axis
  * @property {me.Vector2d} overlapV The overlap vector (i.e. `overlapN.scale(overlap, overlap)`). If this vector is subtracted from the position of a, a and b will no longer be colliding
  * @property {me.Vector2d} overlapN The shortest colliding axis (unit-vector)
- * @property {Boolean} aInB Whether the first object is entirely inside the second
- * @property {Boolean} bInA Whether the second object is entirely inside the first
- * @property {Number} indexShapeA The index of the colliding shape for the object a body
- * @property {Number} indexShapeB The index of the colliding shape for the object b body
+ * @property {boolean} aInB Whether the first object is entirely inside the second
+ * @property {boolean} bInA Whether the second object is entirely inside the first
+ * @property {number} indexShapeA The index of the colliding shape for the object a body
+ * @property {number} indexShapeB The index of the colliding shape for the object b body
  * @name ResponseObject
  * @memberOf me.collision
  * @public
@@ -60,7 +60,6 @@ class ResponseObject {
         this.indexShapeA = -1;
         this.indexShapeB = -1;
         this.overlap = Number.MAX_VALUE;
-        return this;
     }
 
     /**
@@ -72,6 +71,7 @@ class ResponseObject {
      * @memberOf me.collision.ResponseObject
      * @public
      * @function
+     * @returns {object} this object for chaining
      */
     clear () {
         this.aInB = true;
@@ -91,9 +91,9 @@ export var globalResponse = new ResponseObject();
  * @name collisionCheck
  * @ignore
  * @function
- * @param {me.Renderable} obj object to be tested for collision
+ * @param {me.Renderable} objA object to be tested for collision
  * @param {me.collision.ResponseObject} [response=me.collision.response] a user defined response object that will be populated if they intersect.
- * @return {Boolean} in case of collision, false otherwise
+ * @returns {boolean} in case of collision, false otherwise
  */
 export function collisionCheck(objA, response = globalResponse) {
     var collisionCounter = 0;
@@ -165,7 +165,7 @@ export function collisionCheck(objA, response = globalResponse) {
  * @function
  * @param {me.Line} line line to be tested for collision
  * @param {Array.<me.Renderable>} [result] a user defined array that will be populated with intersecting physic objects.
- * @return {Array.<me.Renderable>} an array of intersecting physic objects
+ * @returns {Array.<me.Renderable>} an array of intersecting physic objects
  * @example
  *    // define a line accross the viewport
  *    var ray = new me.Line(

package/src/physics/quadtree.js

@@ -57,9 +57,9 @@ var QT_VECTOR = new Vector2d();
  * @constructor
  * @see me.game.world.broadphase
  * @param {me.Bounds} bounds bounds of the node
- * @param {Number} [max_objects=4] max objects a node can hold before splitting into 4 subnodes
- * @param {Number} [max_levels=4] total max levels inside root Quadtree
- * @param {Number} [level] deepth level, required for subnodes
+ * @param {number} [max_objects=4] max objects a node can hold before splitting into 4 subnodes
+ * @param {number} [max_levels=4] total max levels inside root Quadtree
+ * @param {number} [level] deepth level, required for subnodes
  */
 class QuadTree {
 
@@ -120,23 +120,24 @@ class QuadTree {
     /*
      * Determine which node the object belongs to
      * @param {me.Rect} rect bounds of the area to be checked
-     * @return Integer index of the subnode (0-3), or -1 if rect cannot completely fit within a subnode and is part of the parent node
+     * @returns Integer index of the subnode (0-3), or -1 if rect cannot completely fit within a subnode and is part of the parent node
      */
     getIndex(item) {
         var pos;
+        var bounds = item.getBounds();
 
         // use game world coordinates for floating items
-        if (item.floating || (item.ancestor && item.ancestor.floating)) {
-            pos = viewport.localToWorld(item.left, item.top, QT_VECTOR);
+        if (item.isFloating === true) {
+            pos = viewport.localToWorld(bounds.left, bounds.top, QT_VECTOR);
         } else {
-            pos = QT_VECTOR.set(item.left, item.top);
+            pos = QT_VECTOR.set(bounds.left, bounds.top);
         }
 
         var index = -1,
             rx = pos.x,
             ry = pos.y,
-            rw = item.width,
-            rh = item.height,
+            rw = bounds.width,
+            rh = bounds.height,
             verticalMidpoint = this.bounds.left + (this.bounds.width / 2),
             horizontalMidpoint = this.bounds.top + (this.bounds.height / 2),
             //rect can completely fit within the top quadrants
@@ -197,7 +198,7 @@ class QuadTree {
      * @name insert
      * @memberOf me.QuadTree
      * @function
-     * @param {Object} item object to be added
+     * @param {object} item object to be added
      */
     insert(item) {
         var index = -1;
@@ -242,9 +243,9 @@ class QuadTree {
      * @name retrieve
      * @memberOf me.QuadTree
      * @function
-     * @param {Object} object object to be checked against
-     * @param {Object} [function] a sorting function for the returned array
-     * @return {Object[]} array with all detected objects
+     * @param {object} item object to be checked against
+     * @param {object} [fn] a sorting function for the returned array
+     * @returns {object[]} array with all detected objects
      */
     retrieve(item, fn) {
         var returnObjects = this.objects;
@@ -278,8 +279,8 @@ class QuadTree {
      * @name remove
      * @memberOf me.QuadTree
      * @function
-     * @param {Object} object object to be removed
-     * @return true if the item was found and removed.
+     * @param {object} item object to be removed
+     * @returns {boolean} true if the item was found and removed.
      */
      remove(item) {
         var found = false;
@@ -319,7 +320,7 @@ class QuadTree {
      * @name isPrunable
      * @memberOf me.QuadTree
      * @function
-     * @return true if the node is prunable
+     * @returns {boolean} true if the node is prunable
      */
     isPrunable() {
         return !(this.hasChildren() || (this.objects.length > 0));
@@ -330,7 +331,7 @@ class QuadTree {
      * @name hasChildren
      * @memberOf me.QuadTree
      * @function
-     * @return true if the node has any children
+     * @returns {boolean} true if the node has any children
      */
     hasChildren() {
         for (var i = 0; i < this.nodes.length; i = i + 1) {
@@ -347,6 +348,7 @@ class QuadTree {
      * @name clear
      * @memberOf me.QuadTree
      * @function
+     * @param {me.Bounds} [bounds=this.bounds] the bounds to be cleared
      */
     clear(bounds) {
         this.objects.length = 0;

package/src/physics/sat.js

@@ -26,7 +26,7 @@ var RIGHT_VORNOI_REGION = 1;
 
 /**
  * A pool of `Vector` objects that are used in calculations to avoid allocating memory.
- * @type {Array.<Vector>}
+ * @type {Array.<me.Vector2d>}
  * @ignore
  */
 var T_VECTORS = [];
@@ -46,8 +46,8 @@ for (var a = 0; a < 5; a++) { T_ARRAYS.push([]); }
  * resulting in a one dimensional range of the minimum and
  * maximum value on that axis.
  * @ignore
- * @param {Array.<Vector>} points The points to flatten.
- * @param {Vector} normal The unit vector axis to flatten on.
+ * @param {Array.<me.Vector2d>} points The points to flatten.
+ * @param {me.Vector2d} normal The unit vector axis to flatten on.
  * @param {Array.<number>} result An array.  After calling this function,
  *   result[0] will be the minimum value,
  *   result[1] will be the maximum value.
@@ -70,15 +70,15 @@ function flattenPointsOn(points, normal, result) {
  * Check whether two convex polygons are separated by the specified
  * axis (must be a unit vector).
  * @ignore
- * @param {Vector} aPos The position of the first polygon.
- * @param {Vector} bPos The position of the second polygon.
- * @param {Array.<Vector>} aPoints The points in the first polygon.
- * @param {Array.<Vector>} bPoints The points in the second polygon.
- * @param {Vector} axis The axis (unit sized) to test against.  The points of both polygons
+ * @param {me.Vector2d} aPos The position of the first polygon.
+ * @param {me.Vector2d} bPos The position of the second polygon.
+ * @param {Array.<me.Vector2d>} aPoints The points in the first polygon.
+ * @param {Array.<me.Vector2d>} bPoints The points in the second polygon.
+ * @param {me.Vector2d} axis The axis (unit sized) to test against.  The points of both polygons
  *   will be projected onto this axis.
  * @param {Response=} response A Response object (optional) which will be populated
  *   if the axis is not a separating axis.
- * @return {boolean} true if it is a separating axis, false otherwise.  If false,
+ * @returns {boolean} true if it is a separating axis, false otherwise.  If false,
  *   and a response is passed in, information about how much overlap and
  *   the direction of the overlap will be populated.
  */
@@ -161,9 +161,9 @@ function isSeparatingAxis(aPos, bPos, aPoints, bPoints, axis, response) {
  * </pre>
  *
  * @ignore
- * @param {Vector} line The line segment.
- * @param {Vector} point The point.
- * @return  {number} LEFT_VORNOI_REGION (-1) if it is the left region,
+ * @param {me.Vector2d} line The line segment.
+ * @param {me.Vector2d} point The point.
+ * @returns  {number} LEFT_VORNOI_REGION (-1) if it is the left region,
  *          MIDDLE_VORNOI_REGION (0) if it is the middle region,
  *          RIGHT_VORNOI_REGION (1) if it is the right region.
  */
@@ -192,7 +192,7 @@ function vornoiRegion(line, point) {
  * @param {me.Renderable} b a reference to the object B.
  * @param {me.Polygon} polyB a reference to the object B Polygon to be tested
  * @param {Response=} response Response object (optional) that will be populated if they intersect.
- * @return {boolean} true if they intersect, false if they don't.
+ * @returns {boolean} true if they intersect, false if they don't.
  */
 export function testPolygonPolygon(a, polyA, b, polyB, response) {
     // specific point for
@@ -247,7 +247,7 @@ export function testPolygonPolygon(a, polyA, b, polyB, response) {
  * @param {me.Ellipse} ellipseB a reference to the object B Ellipse to be tested
  * @param {Response=} response Response object (optional) that will be populated if
  *   the circles intersect.
- * @return {boolean} true if the circles intersect, false if they don't.
+ * @returns {boolean} true if the circles intersect, false if they don't.
  */
 export function testEllipseEllipse(a, ellipseA, b, ellipseB, response) {
     // Check if the distance between the centers of the two
@@ -287,7 +287,7 @@ export function testEllipseEllipse(a, ellipseA, b, ellipseB, response) {
  * @param {me.Renderable} b a reference to the object B.
  * @param {me.Ellipse} ellipseB a reference to the object B Ellipse to be tested
  * @param {Response=} response Response object (optional) that will be populated if they intersect.
- * @return {boolean} true if they intersect, false if they don't.
+ * @returns {boolean} true if they intersect, false if they don't.
  */
 export function testPolygonEllipse(a, polyA, b, ellipseB, response) {
     // Get the position of the circle relative to the polygon.
@@ -450,11 +450,11 @@ export function testPolygonEllipse(a, polyA, b, ellipseB, response) {
  * @ignore
  * @param {me.Renderable} a a reference to the object A.
  * @param {me.Ellipse} ellipseA a reference to the object A Ellipse to be tested
- * @param {me.Renderable} a a reference to the object B.
+ * @param {me.Renderable} b a reference to the object B.
  * @param {me.Polygon} polyB a reference to the object B Polygon to be tested
  * @param {Response=} response Response object (optional) that will be populated if
  *   they intersect.
- * @return {boolean} true if they intersect, false if they don't.
+ * @returns {boolean} true if they intersect, false if they don't.
  */
 export function testEllipsePolygon(a, ellipseA, b, polyB, response) {
     // Test the polygon against the circle.

package/src/physics/world.js

@@ -7,16 +7,16 @@ import { collisionCheck } from "./detector.js";
 import state from "./../state/state.js";
 
 /**
-* @classdesc
+ * @classdesc
  * an object representing the physic world, and responsible for managing and updating all childs and physics
  * @class World
  * @extends me.Container
  * @memberOf me
  * @constructor
- * @param {Number} [x=0] position of the container (accessible via the inherited pos.x property)
- * @param {Number} [y=0] position of the container (accessible via the inherited pos.y property)
- * @param {Number} [w=me.game.viewport.width] width of the container
- * @param {Number} [h=me.game.viewport.height] height of the container
+ * @param {number} [x=0] position of the container (accessible via the inherited pos.x property)
+ * @param {number} [y=0] position of the container (accessible via the inherited pos.y property)
+ * @param {number} [w=me.game.viewport.width] width of the container
+ * @param {number} [h=me.game.viewport.height] height of the container
  */
 class World extends Container {
     /**
@@ -37,7 +37,7 @@ class World extends Container {
          * the rate at which the game world is updated,
          * may be greater than or lower than the display fps
          * @public
-         * @type me.Vector2d
+         * @type {me.Vector2d}
          * @default 60
          * @name fps
          * @memberOf me.World
@@ -48,7 +48,7 @@ class World extends Container {
         /**
          * world gravity
          * @public
-         * @type me.Vector2d
+         * @type {me.Vector2d}
          * @default <0,0.98>
          * @name gravity
          * @memberOf me.World
@@ -63,7 +63,7 @@ class World extends Container {
          * (amount of layer, layer size, amount of tiles per layer, etc.)<br>
          * note : rendering method is also configurable per layer by adding this
          * property to your layer (in Tiled).
-         * @type {Boolean}
+         * @type {boolean}
          * @default false
          * @memberOf me.World
          */
@@ -125,7 +125,7 @@ class World extends Container {
      * @see me.Container.addChild
      * @function
      * @param {me.Body} body
-     * @return {me.World} this game world
+     * @returns {me.World} this game world
      */
     addBody(body) {
         //add it to the list of active body
@@ -140,7 +140,7 @@ class World extends Container {
      * @see me.Container.removeChild
      * @function
      * @param {me.Body} body
-     * @return {me.World} this game world
+     * @returns {me.World} this game world
      */
     removeBody(body) {
         //remove from the list of active body
@@ -153,6 +153,8 @@ class World extends Container {
      * @name reset
      * @memberOf me.World
      * @function
+     * @param {number} dt the time passed since the last frame update
+     * @returns {boolean} true if the word is dirty
      */
     update (dt) {
         var isPaused = state.isPaused();

package/src/plugin/plugin.js

@@ -17,7 +17,7 @@ class BasePlugin {
          * define the minimum required version of melonJS<br>
          * this can be overridden by the plugin
          * @public
-         * @type String
+         * @type {string}
          * @default "__VERSION__"
          * @name me.plugin.Base#version
          */
@@ -49,8 +49,8 @@ export var plugin = {
      * @memberOf me.plugin
      * @public
      * @function
-     * @param {Object} proto target object
-     * @param {String} name target function
+     * @param {object} proto target object
+     * @param {string} name target function
      * @param {Function} fn replacement function
      * @example
      * // redefine the me.game.update function with a new one
@@ -95,9 +95,9 @@ export var plugin = {
      * @see me.plugin.Base
      * @public
      * @function
-     * @param {me.plugin.Base} plugin Plugin to instiantiate and register
-     * @param {String} name
-     * @param {} [arguments...] all extra parameters will be passed to the plugin constructor
+     * @param {me.plugin.Base} pluginObj Plugin object to instantiate and register
+     * @param {string} name
+     * @param {object} [...arguments] all extra parameters will be passed to the plugin constructor
      * @example
      * // register a new plugin
      * me.plugin.register(TestPlugin, "testPlugin");