melonjs 14.0.2 → 14.1.0

package/src/renderable/ui/uibaseelement.js

@@ -12,10 +12,10 @@ import { registerPointerEvent, releasePointerEvent} from "./../../input/input.js
 class UIBaseElement extends Container {
     /**
      *
-     * @param {number} x The x position of the container
-     * @param {number} y The y position of the container
-     * @param {number} w width of the container (default: viewport width)
-     * @param {number} h height of the container (default: viewport height)
+     * @param {number} x - The x position of the container
+     * @param {number} y - The y position of the container
+     * @param {number} w - width of the container (default: viewport width)
+     * @param {number} h - height of the container (default: viewport height)
      */
     constructor(x, y, w, h) {
         super(x, y, w, h);
@@ -83,7 +83,7 @@ class UIBaseElement extends Container {
 
     /**
      * function called when the object is pressed (to be extended)
-     * @param {Pointer} event the event object
+     * @param {Pointer} event - the event object
      * @returns {boolean} return false if we need to stop propagating the event
      */
     onClick(event) { // eslint-disable-line no-unused-vars
@@ -102,7 +102,7 @@ class UIBaseElement extends Container {
 
     /**
      * function called when the pointer is over the object
-     * @param {Pointer} event the event object
+     * @param {Pointer} event - the event object
      */
     onOver(event) { // eslint-disable-line no-unused-vars
         // to be extended
@@ -121,7 +121,7 @@ class UIBaseElement extends Container {
 
     /**
      * function called when the pointer is leaving the object area
-     * @param {Pointer} event the event object
+     * @param {Pointer} event - the event object
      */
     onOut(event) { // eslint-disable-line no-unused-vars
         // to be extended

package/src/renderable/ui/uispriteelement.js

@@ -9,9 +9,9 @@ import { registerPointerEvent, releasePointerEvent} from "./../../input/input.js
  */
 class UISpriteElement extends 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}
+     * @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}
      * @example
      * // create a basic GUI Object
      * class myButton extends UISpriteElement {
@@ -104,7 +104,7 @@ class UISpriteElement extends Sprite {
 
     /**
      * function called when the object is pressed (to be extended)
-     * @param {Pointer} event the event object
+     * @param {Pointer} event - the event object
      * @returns {boolean} return false if we need to stop propagating the event
      */
     onClick(event) { // eslint-disable-line no-unused-vars
@@ -123,7 +123,7 @@ class UISpriteElement extends Sprite {
 
     /**
      * function called when the pointer is over the object
-     * @param {Pointer} event the event object
+     * @param {Pointer} event - the event object
      */
     onOver(event) { // eslint-disable-line no-unused-vars
         // to be extended
@@ -142,7 +142,7 @@ class UISpriteElement extends Sprite {
 
     /**
      * function called when the pointer is leaving the object area
-     * @param {Pointer} event the event object
+     * @param {Pointer} event - the event object
      */
     onOut(event) { // eslint-disable-line no-unused-vars
         // to be extended

package/src/renderable/ui/uitextbutton.js

@@ -15,19 +15,19 @@ class UITextButton extends UIBaseElement {
      * It uses a RoundRect as background and changes the background color on hovering over.
      * The background will be drawn with 0.5 opacity, so that the background of the button is
      * slightly shining through.
-     * @param {number} x x pos of the button
-     * @param {number} y y pos of the button
-     * @param {string} [settings.font] The name of the BitmapText font to use
-     * @param {number} [settings.size] The scale factor of the font (default: 1)
-     * @param {string} [settings.text] The text to display (default: 'click me')
-     * @param {string} [settings.bindKey] The key to bind the action to (default: none)
-     * @param {string} [settings.backgroundColor] The css value of a background color
-     * @param {string} [settings.hoverColor] The css value of a color to be used if the pointer hovers over the button
-     * @param {string} [settings.borderStrokeColor] The css value of a color to be used to draw the border
-     * @param {boolean} [settings.offScreenCanvas] Weather to use an offScreen canvas or not
-     * @param {string} [settings.fillStyle] The css value of a tint color to be used to tint the text
-     * @param {number} [settings.borderWidth] Width of the button
-     * @param {number} [settings.borderHeight] Height of the button
+     * @param {number} x - x pos of the button
+     * @param {number} y - y pos of the button
+     * @param {string} [settings.font] - The name of the BitmapText font to use
+     * @param {number} [settings.size] - The scale factor of the font (default: 1)
+     * @param {string} [settings.text] - The text to display (default: 'click me')
+     * @param {string} [settings.bindKey] - The key to bind the action to (default: none)
+     * @param {string} [settings.backgroundColor] - The css value of a background color
+     * @param {string} [settings.hoverColor] - The css value of a color to be used if the pointer hovers over the button
+     * @param {string} [settings.borderStrokeColor] - The css value of a color to be used to draw the border
+     * @param {boolean} [settings.offScreenCanvas] - Weather to use an offScreen canvas or not
+     * @param {string} [settings.fillStyle] - The css value of a tint color to be used to tint the text
+     * @param {number} [settings.borderWidth] - Width of the button
+     * @param {number} [settings.borderHeight] - Height of the button
      * @example
      * // Create a new Button
      * class PlayButton extends BaseTextButton {

package/src/state/stage.js

@@ -21,10 +21,10 @@ var default_settings = {
 class Stage {
 
     /**
-     * @param {object} [settings] The stage` parameters
-     * @param {Camera2d[]} [settings.cameras=[new me.Camera2d()]] a list of cameras (experimental)
-     * @param {Function} [settings.onResetEvent] called by the state manager when reseting the object
-     * @param {Function} [settings.onDestroyEvent] called by the state manager before switching to another state
+     * @param {object} [settings] - The stage` parameters
+     * @param {Camera2d[]} [settings.cameras=[new me.Camera2d()]] - a list of cameras (experimental)
+     * @param {Function} [settings.onResetEvent] - called by the state manager when reseting the object
+     * @param {Function} [settings.onDestroyEvent] - called by the state manager before switching to another state
      */
     constructor(settings) {
         /**
@@ -116,7 +116,7 @@ class Stage {
      * @name update
      * @memberof Stage
      * @ignore
-     * @param {number} dt time since the last update in milliseconds.
+     * @param {number} dt - time since the last update in milliseconds.
      * @returns {boolean}
      */
     update(dt) {
@@ -146,7 +146,7 @@ class Stage {
      * @name draw
      * @memberof Stage
      * @ignore
-     * @param {CanvasRenderer|WebGLRenderer} renderer a renderer object
+     * @param {CanvasRenderer|WebGLRenderer} renderer - a renderer object
      */
     draw(renderer) {
         // iterate through all cameras
@@ -201,7 +201,7 @@ class Stage {
      * this is typically where you will load a level, add renderables, etc...
      * @name onResetEvent
      * @memberof Stage
-     * @param {object} [...arguments] optional arguments passed when switching state
+     * @param {object} [...arguments] - optional arguments passed when switching state
      * @see state#change
      */
     onResetEvent() {

package/src/state/state.js

@@ -68,7 +68,7 @@ function _pauseRunLoop() {
 
 /**
  * this is only called when using requestAnimFrame stuff
- * @param {number} time current timestamp in milliseconds
+ * @param {number} time - current timestamp in milliseconds
  * @ignore
  */
 function _renderFrame(time) {
@@ -296,7 +296,7 @@ var state = {
      * @name stop
      * @memberof state
      * @public
-     * @param {boolean} [pauseTrack=false] pause current track on screen stop.
+     * @param {boolean} [pauseTrack=false] - pause current track on screen stop.
      */
     stop(pauseTrack=false) {
         // only stop when we are not loading stuff
@@ -322,7 +322,7 @@ var state = {
      * @name pause
      * @memberof state
      * @public
-     * @param {boolean} [music=false] pause current music track on screen pause
+     * @param {boolean} [music=false] - pause current music track on screen pause
      */
     pause(music=false) {
         // only pause when we are not loading stuff
@@ -347,7 +347,7 @@ var state = {
      * @name restart
      * @memberof state
      * @public
-     * @param {boolean} [music=false] resume current music track on screen resume
+     * @param {boolean} [music=false] - resume current music track on screen resume
      */
     restart(music=false) {
         if (!this.isRunning()) {
@@ -374,7 +374,7 @@ var state = {
      * @name resume
      * @memberof state
      * @public
-     * @param {boolean} [music=false] resume current music track on screen resume
+     * @param {boolean} [music=false] - resume current music track on screen resume
      */
     resume(music=false) {
         if (this.isPaused()) {
@@ -420,9 +420,9 @@ var state = {
      * @name set
      * @memberof state
      * @public
-     * @param {number} state State ID (see constants)
-     * @param {Stage} stage Instantiated Stage to associate with state ID
-     * @param {boolean} [start = false] if true the state will be changed immediately after adding it.
+     * @param {number} state - State ID (see constants)
+     * @param {Stage} stage - Instantiated Stage to associate with state ID
+     * @param {boolean} [start = false] - if true the state will be changed immediately after adding it.
      * @example
      * class MenuButton extends me.GUI_Object {
      *     onClick() {
@@ -479,7 +479,7 @@ var state = {
      * @name set
      * @memberof state
      * @public
-     * @param {number} [state] State ID (see constants)
+     * @param {number} [state] - State ID (see constants)
      * @returns {Stage}
      */
     get(state = _state) {
@@ -508,9 +508,9 @@ var state = {
      * @name transition
      * @memberof state
      * @public
-     * @param {string} effect (only "fade" is supported for now)
-     * @param {Color|string} color a CSS color value
-     * @param {number} [duration=1000] expressed in milliseconds
+     * @param {string} effect - (only "fade" is supported for now)
+     * @param {Color|string} color - a CSS color value
+     * @param {number} [duration=1000] - expressed in milliseconds
      */
     transition(effect, color, duration) {
         if (effect === "fade") {
@@ -524,7 +524,7 @@ var state = {
      * @name setTransition
      * @memberof state
      * @public
-     * @param {number} state State ID (see constants)
+     * @param {number} state - State ID (see constants)
      * @param {boolean} enable
      */
     setTransition(state, enable) {
@@ -536,9 +536,9 @@ var state = {
      * @name change
      * @memberof state
      * @public
-     * @param {number} state State ID (see constants)
-     * @param {boolean} forceChange if true the state will be changed immediately
-     * @param {object} [...arguments] extra arguments to be passed to the reset functions
+     * @param {number} state - State ID (see constants)
+     * @param {boolean} forceChange - if true the state will be changed immediately
+     * @param {object} [...arguments] - extra arguments to be passed to the reset functions
      * @example
      * // The onResetEvent method on the play screen will receive two args:
      * // "level_1" and the number 3
@@ -589,7 +589,7 @@ var state = {
      * @name isCurrent
      * @memberof state
      * @public
-     * @param {number} state State ID (see constants)
+     * @param {number} state - State ID (see constants)
      * @returns {boolean} true if the specified state is the current one
      */
     isCurrent(state) {

package/src/system/device.js

@@ -389,7 +389,7 @@ export let stopOnBlur = false;
 * @function onReady
 * @memberof device
 * @public
-* @param {Function} fn the function to be executed
+* @param {Function} fn - the function to be executed
 * @example
 * // small game skeleton
 * var game = {
@@ -438,7 +438,7 @@ export function onReady(fn) {
  * @function enableSwipe
  * @memberof device
  * @public
- * @param {boolean} [enable=true] enable or disable swipe.
+ * @param {boolean} [enable=true] - enable or disable swipe.
  */
 export function enableSwipe(enable) {
     let moveEvent = pointerEvent ? "pointermove" : (touchEvent ? "touchmove" : "mousemove");
@@ -473,7 +473,7 @@ export function isFullscreen() {
  * @function requestFullscreen
  * @memberof device
  * @public
- * @param {object} [element=default canvas object] the element to be set in full-screen mode.
+ * @param {object} [element=default canvas object] - the element to be set in full-screen mode.
  * @example
  * // add a keyboard shortcut to toggle Fullscreen mode on/off
  * me.input.bindKey(me.input.KEY.F, "toggleFullscreen");
@@ -549,7 +549,7 @@ export function getScreenOrientation() {
  * @memberof device
  * @public
  * @see https://developer.mozilla.org/en-US/docs/Web/API/Screen/lockOrientation
- * @param {string|string[]} orientation The orientation into which to lock the screen.
+ * @param {string|string[]} orientation - The orientation into which to lock the screen.
  * @returns {boolean} true if the orientation was unsuccessfully locked
  */
 export function lockOrientation(orientation) {
@@ -629,7 +629,7 @@ export function getStorage(type = "local") {
  * @function getParentElement
  * @memberof device
  * @public
- * @param {string|HTMLElement} element the parent element name or a HTMLElement object
+ * @param {string|HTMLElement} element - the parent element name or a HTMLElement object
  * @returns {HTMLElement} the parent Element
  */
 export function getParentElement(element) {
@@ -647,7 +647,7 @@ export function getParentElement(element) {
  * @function getElement
  * @memberof device
  * @public
- * @param {string|HTMLElement} element the parent element name or a HTMLElement object
+ * @param {string|HTMLElement} element - the parent element name or a HTMLElement object
  * @returns {HTMLElement} the corresponding DOM Element or null if not existing
  */
 export function getElement(element) {
@@ -677,7 +677,7 @@ export function getElement(element) {
  * @memberof device
  * @public
  * @see https://developer.mozilla.org/en-US/docs/Web/API/DOMRect
- * @param {string|HTMLElement} element an HTMLElement object
+ * @param {string|HTMLElement} element - an HTMLElement object
  * @returns {DOMRect} the size and position of the element relatively to the viewport
  */
 export function getElementBounds(element) {
@@ -697,7 +697,7 @@ export function getElementBounds(element) {
  * @memberof device
  * @public
  * @see https://developer.mozilla.org/en-US/docs/Web/API/DOMRect
- * @param {string|HTMLElement} element an HTMLElement object
+ * @param {string|HTMLElement} element - an HTMLElement object
  * @returns {DOMRect} the size and position of the given element parent relative to the viewport
  */
 export function getParentBounds(element) {
@@ -709,8 +709,8 @@ export function getParentBounds(element) {
  * @function isWebGLSupported
  * @memberof device
  * @public
- * @param {object} [options] context creation options
- * @param {boolean} [options.failIfMajorPerformanceCaveat=true] If true, the renderer will switch to CANVAS mode if the performances of a WebGL context would be dramatically lower than that of a native application making equivalent OpenGL calls.
+ * @param {object} [options] - context creation options
+ * @param {boolean} [options.failIfMajorPerformanceCaveat=true] - If true, the renderer will switch to CANVAS mode if the performances of a WebGL context would be dramatically lower than that of a native application making equivalent OpenGL calls.
  * @returns {boolean} true if WebGL is supported
  */
 export function isWebGLSupported(options) {
@@ -882,7 +882,7 @@ export function unwatchDeviceOrientation() {
  * @function vibrate
  * @memberof device
  * @public
- * @param {number|number[]} pattern pattern of vibration and pause intervals
+ * @param {number|number[]} pattern - pattern of vibration and pause intervals
  * @example
  * // vibrate for 1000 ms
  * me.device.vibrate(1000);

package/src/system/event.js

@@ -473,8 +473,8 @@ export const ONCONTEXT_RESTORED = "renderer.contextrestored";
 /**
  * calls each of the listeners registered for a given event.
  * @function event.emit
- * @param {string|symbol} eventName The event name.
- * @param {object} [...arguments] arguments to be passed to all listeners
+ * @param {string|symbol} eventName - The event name.
+ * @param {object} [...arguments] - arguments to be passed to all listeners
  * @returns {boolean} true if the event had listeners, false otherwise.
  * @example
  * me.event.emit("event-name", a, b, c);
@@ -486,9 +486,9 @@ export function emit(eventName, ...args) {
 /**
  * Add a listener for a given event.
  * @function event.on
- * @param {string|symbol} eventName The event name.
- * @param {Function} listener The listener function.
- * @param {*} [context=this] The context to invoke the listener with.
+ * @param {string|symbol} eventName - The event name.
+ * @param {Function} listener - The listener function.
+ * @param {*} [context=this] - The context to invoke the listener with.
  * @returns {EventEmitter} `this`.
  * @public
  * @example
@@ -501,9 +501,9 @@ export function on(eventName, listener, context) {
 /**
  * Add a one-time listener for a given event.
  * @function event.once
- * @param {string|symbol} eventName The event name.
- * @param {Function} listener The listener function.
- * @param {*} [context=this] The context to invoke the listener with.
+ * @param {string|symbol} eventName - The event name.
+ * @param {Function} listener - The listener function.
+ * @param {*} [context=this] - The context to invoke the listener with.
  * @returns {EventEmitter} `this`.
  * @public
  * @example
@@ -516,8 +516,8 @@ export function once(eventName, listener, context) {
 /**
  * remove the given listener for a given event.
  * @function event.off
- * @param {string|symbol} eventName The event name.
- * @param {Function} listener The listener function.
+ * @param {string|symbol} eventName - The event name.
+ * @param {Function} listener - The listener function.
  * @returns {EventEmitter} `this`.
  * @public
  * @example

package/src/system/pooling.js

@@ -23,9 +23,9 @@ class ObjectPool {
      * register an object to the pool. <br>
      * Pooling must be set to true if more than one such objects will be created. <br>
      * (Note: for an object to be poolable, it must implements a `onResetEvent` method)
-     * @param {string} className as defined in the Name field of the Object Properties (in Tiled)
-     * @param {object} classObj corresponding Class to be instantiated
-     * @param {boolean} [recycling=false] enables object recycling for the specified class
+     * @param {string} className - as defined in the Name field of the Object Properties (in Tiled)
+     * @param {object} classObj - corresponding Class to be instantiated
+     * @param {boolean} [recycling=false] - enables object recycling for the specified class
      * @example
      * // implement CherryEntity
      * class CherryEntity extends Spritesheet {
@@ -50,8 +50,8 @@ class ObjectPool {
 
     /**
      * Pull a new instance of the requested object (if added into the object pool)
-     * @param {string} name as used in {@link pool.register}
-     * @param {object} [...arguments] arguments to be passed when instantiating/reinitializing the object
+     * @param {string} name - as used in {@link pool.register}
+     * @param {object} [...arguments] - arguments to be passed when instantiating/reinitializing the object
      * @returns {object} the instance of the requested object
      * @example
      * me.pool.register("bullet", BulletEntity, true);
@@ -122,8 +122,8 @@ class ObjectPool {
      * and object must have been instantiated using {@link pool#pull},
      * otherwise this function won't work
      * @throws will throw an error if the object cannot be recycled
-     * @param {object} obj instance to be recycled
-     * @param {boolean} [throwOnError=true] throw an exception if the object cannot be recycled
+     * @param {object} obj - instance to be recycled
+     * @param {boolean} [throwOnError=true] - throw an exception if the object cannot be recycled
      * @returns {boolean} true if the object was successfully recycled in the object pool
      */
     push(obj, throwOnError = true) {
@@ -144,7 +144,7 @@ class ObjectPool {
 
     /**
      * Check if an object with the provided name is registered
-     * @param {string} name of the registered object class
+     * @param {string} name - of the registered object class
      * @returns {boolean} true if the classname is registered
      */
     exists(name) {
@@ -155,7 +155,7 @@ class ObjectPool {
      * Check if an object is poolable
      * (was properly registered with the recycling feature enable)
      * @see register
-     * @param {object} obj object to be checked
+     * @param {object} obj - object to be checked
      * @returns {boolean} true if the object is poolable
      * @example
      * if (!me.pool.poolable(myCherryEntity)) {

package/src/system/save.js

@@ -74,7 +74,7 @@ var save = {
      * Add new keys to localStorage and set them to the given default values if they do not exist
      * @name add
      * @memberof save
-     * @param {object} props key and corresponding values
+     * @param {object} props - key and corresponding values
      * @example
      * // Initialize "score" and "lives" with default values
      * me.save.add({ score : 0, lives : 3 });
@@ -127,7 +127,7 @@ var save = {
      * Remove a key from localStorage
      * @name remove
      * @memberof save
-     * @param {string} key key to be removed
+     * @param {string} key - key to be removed
      * @example
      * // Remove the "score" key from localStorage
      * me.save.remove("score");

package/src/system/timer.js

@@ -105,10 +105,10 @@ class Timer {
 
     /**
      * Calls a function once after a specified delay. See me.timer.setInterval to repeativly call a function.
-     * @param {Function} fn the function you want to execute after delay milliseconds.
-     * @param {number} delay the number of milliseconds (thousandths of a second) that the function call should be delayed by.
-     * @param {boolean} [pauseable=true] respects the pause state of the engine.
-     * @param {...*} args optional parameters which are passed through to the function specified by fn once the timer expires.
+     * @param {Function} fn - the function you want to execute after delay milliseconds.
+     * @param {number} delay - the number of milliseconds (thousandths of a second) that the function call should be delayed by.
+     * @param {boolean} [pauseable=true] - respects the pause state of the engine.
+     * @param {...*} args - optional parameters which are passed through to the function specified by fn once the timer expires.
      * @returns {number} The numerical ID of the timer, which can be used later with me.timer.clearTimeout().
      * @example
      * // set a timer to call "myFunction" after 1000ms
@@ -131,10 +131,10 @@ class Timer {
 
     /**
      * Calls a function continously at the specified interval.  See setTimeout to call function a single time.
-     * @param {Function} fn the function to execute
-     * @param {number} delay the number of milliseconds (thousandths of a second) on how often to execute the function
-     * @param {boolean} [pauseable=true] respects the pause state of the engine.
-     * @param {...*} args optional parameters which are passed through to the function specified by fn once the timer expires.
+     * @param {Function} fn - the function to execute
+     * @param {number} delay - the number of milliseconds (thousandths of a second) on how often to execute the function
+     * @param {boolean} [pauseable=true] - respects the pause state of the engine.
+     * @param {...*} args - optional parameters which are passed through to the function specified by fn once the timer expires.
      * @returns {number} The numerical ID of the timer, which can be used later with me.timer.clearInterval().
      * @example
      * // set a timer to call "myFunction" every 1000ms
@@ -157,7 +157,7 @@ class Timer {
 
     /**
      * Clears the delay set by me.timer.setTimeout().
-     * @param {number} timeoutID ID of the timeout to be cleared
+     * @param {number} timeoutID - ID of the timeout to be cleared
      */
     clearTimeout(timeoutID) {
         utils.function.defer(this.clearTimer.bind(this), this, timeoutID);
@@ -165,7 +165,7 @@ class Timer {
 
     /**
      * Clears the Interval set by me.timer.setInterval().
-     * @param {number} intervalID ID of the interval to be cleared
+     * @param {number} intervalID - ID of the interval to be cleared
      */
     clearInterval(intervalID) {
         utils.function.defer(this.clearTimer.bind(this), this, intervalID);

package/src/text/bitmaptext.js

@@ -11,20 +11,20 @@ import TextMetrics from "./textmetrics.js";
  */
 class BitmapText extends Renderable {
     /**
-     * @param {number} x position of the text object
-     * @param {number} y position of the text object
-     * @param {object} settings the text configuration
-     * @param {string|Image} settings.font a font name to identify the corresponing source image
-     * @param {string} [settings.fontData=settings.font] the bitmap font data corresponding name, or the bitmap font data itself
-     * @param {number} [settings.size] size a scaling ratio
-     * @param {Color|string} [settings.fillStyle] a CSS color value used to tint the bitmapText (@see BitmapText.tint)
-     * @param {number} [settings.lineWidth=1] line width, in pixels, when drawing stroke
-     * @param {string} [settings.textAlign="left"] horizontal text alignment
-     * @param {string} [settings.textBaseline="top"] the text baseline
-     * @param {number} [settings.lineHeight=1.0] line spacing height
-     * @param {Vector2d} [settings.anchorPoint={x:0.0, y:0.0}] anchor point to draw the text at
-     * @param {number} [settings.wordWrapWidth] the maximum length in CSS pixel for a single segment of text
-     * @param {(string|string[])} [settings.text] a string, or an array of strings
+     * @param {number} x - position of the text object
+     * @param {number} y - position of the text object
+     * @param {object} settings - the text configuration
+     * @param {string|Image} settings.font - a font name to identify the corresponing source image
+     * @param {string} [settings.fontData=settings.font] - the bitmap font data corresponding name, or the bitmap font data itself
+     * @param {number} [settings.size] - size a scaling ratio
+     * @param {Color|string} [settings.fillStyle] - a CSS color value used to tint the bitmapText (@see BitmapText.tint)
+     * @param {number} [settings.lineWidth=1] - line width, in pixels, when drawing stroke
+     * @param {string} [settings.textAlign="left"] - horizontal text alignment
+     * @param {string} [settings.textBaseline="top"] - the text baseline
+     * @param {number} [settings.lineHeight=1.0] - line spacing height
+     * @param {Vector2d} [settings.anchorPoint={x:0.0, y:0.0}] - anchor point to draw the text at
+     * @param {number} [settings.wordWrapWidth] - the maximum length in CSS pixel for a single segment of text
+     * @param {(string|string[])} [settings.text] - a string, or an array of strings
      * @example
      * // Use me.loader.preload or me.loader.load to load assets
      * me.loader.preload([
@@ -142,7 +142,7 @@ class BitmapText extends Renderable {
 
     /**
      * change the font settings
-     * @param {string} textAlign ("left", "center", "right")
+     * @param {string} textAlign - ("left", "center", "right")
      * @param {number} [scale]
      * @returns {BitmapText} this object for chaining
      */
@@ -159,7 +159,7 @@ class BitmapText extends Renderable {
 
     /**
      * change the text to be displayed
-     * @param {number|string|string[]} value a string, or an array of strings
+     * @param {number|string|string[]} value - a string, or an array of strings
      * @returns {BitmapText} this object for chaining
      */
     setText(value = "") {
@@ -201,7 +201,7 @@ class BitmapText extends Renderable {
 
     /**
      * change the font display size
-     * @param {number} scale ratio
+     * @param {number} scale - ratio
      * @returns {BitmapText} this object for chaining
      */
     resize(scale) {
@@ -226,7 +226,7 @@ class BitmapText extends Renderable {
 
     /**
      * draw the bitmap font
-     * @param {CanvasRenderer|WebGLRenderer} renderer Reference to the destination renderer instance
+     * @param {CanvasRenderer|WebGLRenderer} renderer - Reference to the destination renderer instance
      * @param {string} [text]
      * @param {number} [x]
      * @param {number} [y]

package/src/text/bitmaptextdata.js

@@ -21,7 +21,7 @@ function getValueFromPair(string, pattern) {
  * @ignore
  * @name _getFirstGlyph
  * @memberof BitmapTextData
- * @param {object} glyphs the map of glyphs, each key is a char code
+ * @param {object} glyphs - the map of glyphs, each key is a char code
  * @returns {Glyph}
  */
 function getFirstGlyph(glyphs) {
@@ -39,7 +39,7 @@ function getFirstGlyph(glyphs) {
  * @ignore
  * @name createSpaceGlyph
  * @memberof BitmapTextData
- * @param {object} glyphs the map of glyphs, each key is a char code
+ * @param {object} glyphs - the map of glyphs, each key is a char code
  */
 function createSpaceGlyph(glyphs) {
     var spaceCharCode = " ".charCodeAt(0);