Fixed jsdocs

Author: photonstorm

src/cameras/2d/Camera.js

@@ -834,6 +834,7 @@ var Camera = new Class({
      * @since 3.0.0
      *
      * @param {number} baseScale - [description]
+     * @param {number} resolution - [description]
      *
      */
     preRender: function (baseScale, resolution)

src/display/canvas/CanvasInterpolation.js

@@ -5,15 +5,15 @@
  */
 
 /**
- * @module Phaser.Display.Canvas.CanvasInterpolation
+ * @namespace Phaser.Display.Canvas.CanvasInterpolation
  * @since 3.0.0
  */
 var CanvasInterpolation = {
 
     /**
      * Sets the CSS image-rendering property on the given canvas to be 'crisp' (aka 'optimize contrast' on webkit).
      *
-     * @function setCrisp
+     * @function Phaser.Display.Canvas.CanvasInterpolation.setCrisp
      * @since 3.0.0
      * 
      * @param {HTMLCanvasElement} canvas - The canvas object to have the style set on.
@@ -37,7 +37,7 @@ var CanvasInterpolation = {
     /**
      * Sets the CSS image-rendering property on the given canvas to be 'bicubic' (aka 'auto').
      *
-     * @function setBicubic
+     * @function Phaser.Display.Canvas.CanvasInterpolation.setBicubic
      * @since 3.0.0
      * 
      * @param {HTMLCanvasElement} canvas - The canvas object to have the style set on.

src/display/canvas/CanvasPool.js

@@ -13,15 +13,32 @@ var pool = [];
 //  Automatically apply smoothing(false) to created Canvas elements
 var _disableContextSmoothing = false;
 
-//  This singleton is instantiated as soon as Phaser loads,
-//  before a Phaser.Game instance has even been created.
-//  Which means all instances of Phaser Games on the same page
-//  can share the one single pool
-
-// The CanvasPool is a global static object, that allows Phaser to recycle and pool Canvas DOM elements.
+/**
+ * The CanvasPool is a global static object, that allows Phaser to recycle and pool Canvas DOM elements.
+ *
+ * This singleton is instantiated as soon as Phaser loads,
+ * before a Phaser.Game instance has even been created.
+ * Which means all instances of Phaser Games on the same page
+ * can share the one single pool
+ * 
+ * @namespace Phaser.Display.Canvas.CanvasPool
+ * @since 3.0.0
+ */
 var CanvasPool = function ()
 {
-    // Creates a new Canvas DOM element, or pulls one from the pool if free.
+    /**
+     * Creates a new Canvas DOM element, or pulls one from the pool if free.
+     *
+     * @function Phaser.Display.Canvas.CanvasPool.create
+     * @since 3.0.0
+     * 
+     * @param {any} parent - [description]
+     * @param {integer} [width=1] - [description]
+     * @param {integer} [height=1] - [description]
+     * @param {integer} [type] - [description]
+     * 
+     * @return {HTMLCanvasElement} [description]
+     */
     var create = function (parent, width, height, type)
     {
         if (width === undefined) { width = 1; }
@@ -61,17 +78,50 @@ var CanvasPool = function ()
         return canvas;
     };
 
+    /**
+     * Creates a new Canvas DOM element, or pulls one from the pool if free.
+     *
+     * @function Phaser.Display.Canvas.CanvasPool.create2D
+     * @since 3.0.0
+     * 
+     * @param {any} parent - [description]
+     * @param {integer} [width=1] - [description]
+     * @param {integer} [height=1] - [description]
+     * 
+     * @return {HTMLCanvasElement} [description]
+     */
     var create2D = function (parent, width, height)
     {
         return create(parent, width, height, CONST.CANVAS);
     };
 
+    /**
+     * Creates a new Canvas DOM element, or pulls one from the pool if free.
+     *
+     * @function Phaser.Display.Canvas.CanvasPool.createWebGL
+     * @since 3.0.0
+     * 
+     * @param {any} parent - [description]
+     * @param {integer} [width=1] - [description]
+     * @param {integer} [height=1] - [description]
+     * 
+     * @return {HTMLCanvasElement} [description]
+     */
     var createWebGL = function (parent, width, height)
     {
         return create(parent, width, height, CONST.WEBGL);
     };
 
-    // Gets the first free canvas index from the pool.
+    /**
+     * Gets the first free canvas index from the pool.
+     *
+     * @function Phaser.Display.Canvas.CanvasPool.first
+     * @since 3.0.0
+     * 
+     * @param {integer} [type] - [description]
+     * 
+     * @return {HTMLCanvasElement} [description]
+     */
     var first = function (type)
     {
         if (type === undefined) { type = CONST.CANVAS; }
@@ -87,8 +137,15 @@ var CanvasPool = function ()
         return null;
     };
 
-    //  Looks up a canvas based on its parent, and if found puts it back in the pool, freeing it up for re-use.
-    //  The canvas has its width and height set to 1, and its parent attribute nulled.
+    /**
+     * Looks up a canvas based on its parent, and if found puts it back in the pool, freeing it up for re-use.
+     * The canvas has its width and height set to 1, and its parent attribute nulled.
+     *
+     * @function Phaser.Display.Canvas.CanvasPool.remove
+     * @since 3.0.0
+     * 
+     * @param {any} parent - [description]
+     */
     var remove = function (parent)
     {
         //  Check to see if the parent is a canvas object
@@ -106,7 +163,14 @@ var CanvasPool = function ()
         });
     };
 
-    //  Gets the total number of used canvas elements in the pool.
+    /**
+     * Gets the total number of used canvas elements in the pool.
+     *
+     * @function Phaser.Display.Canvas.CanvasPool.total
+     * @since 3.0.0
+     * 
+     * @return {integer} [description]
+     */
     var total = function ()
     {
         var c = 0;
@@ -122,19 +186,36 @@ var CanvasPool = function ()
         return c;
     };
 
-    //  Gets the total number of free canvas elements in the pool.
+    /**
+     * Gets the total number of free canvas elements in the pool.
+     *
+     * @function Phaser.Display.Canvas.CanvasPool.free
+     * @since 3.0.0
+     * 
+     * @return {integer} [description]
+     */
     var free = function ()
     {
         return pool.length - total();
     };
 
-    //  Disable context smoothing on any new Canvas element created
+    /**
+     * Disable context smoothing on any new Canvas element created.
+     *
+     * @function Phaser.Display.Canvas.CanvasPool.disableSmoothing
+     * @since 3.0.0
+     */
     var disableSmoothing = function ()
     {
         _disableContextSmoothing = true;
     };
 
-    //  Enable context smoothing on any new Canvas element created
+    /**
+     * Enable context smoothing on any new Canvas element created.
+     *
+     * @function Phaser.Display.Canvas.CanvasPool.enableSmoothing
+     * @since 3.0.0
+     */
     var enableSmoothing = function ()
     {
         _disableContextSmoothing = false;

src/display/canvas/Smoothing.js

@@ -4,13 +4,25 @@
  * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
  */
 
-
 //  Browser specific prefix, so not going to change between contexts, only between browsers
 var prefix = '';
 
+/**
+ * @namespace Phaser.Display.Canvas.Smoothing
+ * @since 3.0.0
+ */
 var Smoothing = function ()
 {
-    // Gets the Smoothing Enabled vendor prefix being used on the given context, or null if not set.
+    /**
+     * Gets the Smoothing Enabled vendor prefix being used on the given context, or null if not set.
+     *
+     * @function Phaser.Display.Canvas.Smoothing.getPrefix
+     * @since 3.0.0
+     * 
+     * @param {[type]} context - [description]
+     * 
+     * @return {string} [description]
+     */
     var getPrefix = function (context)
     {
         var vendors = [ 'i', 'webkitI', 'msI', 'mozI', 'oI' ];
@@ -29,12 +41,19 @@ var Smoothing = function ()
     };
 
     /**
-    * Sets the Image Smoothing property on the given context. Set to false to disable image smoothing.
-    * By default browsers have image smoothing enabled, which isn't always what you visually want, especially
-    * when using pixel art in a game. Note that this sets the property on the context itself, so that any image
-    * drawn to the context will be affected. This sets the property across all current browsers but support is
-    * patchy on earlier browsers, especially on mobile.
-    */
+     * Sets the Image Smoothing property on the given context. Set to false to disable image smoothing.
+     * By default browsers have image smoothing enabled, which isn't always what you visually want, especially
+     * when using pixel art in a game. Note that this sets the property on the context itself, so that any image
+     * drawn to the context will be affected. This sets the property across all current browsers but support is
+     * patchy on earlier browsers, especially on mobile.
+     *
+     * @function Phaser.Display.Canvas.Smoothing.enable
+     * @since 3.0.0
+     * 
+     * @param {[type]} context - [description]
+     * 
+     * @return {[type]} [description]
+     */
     var enable = function (context)
     {
         if (prefix === '')
@@ -51,12 +70,19 @@ var Smoothing = function ()
     };
 
     /**
-    * Sets the Image Smoothing property on the given context. Set to false to disable image smoothing.
-    * By default browsers have image smoothing enabled, which isn't always what you visually want, especially
-    * when using pixel art in a game. Note that this sets the property on the context itself, so that any image
-    * drawn to the context will be affected. This sets the property across all current browsers but support is
-    * patchy on earlier browsers, especially on mobile.
-    */
+     * Sets the Image Smoothing property on the given context. Set to false to disable image smoothing.
+     * By default browsers have image smoothing enabled, which isn't always what you visually want, especially
+     * when using pixel art in a game. Note that this sets the property on the context itself, so that any image
+     * drawn to the context will be affected. This sets the property across all current browsers but support is
+     * patchy on earlier browsers, especially on mobile.
+     *
+     * @function Phaser.Display.Canvas.Smoothing.disable
+     * @since 3.0.0
+     * 
+     * @param {[type]} context - [description]
+     * 
+     * @return {[type]} [description]
+     */
     var disable = function (context)
     {
         if (prefix === '')
@@ -75,6 +101,13 @@ var Smoothing = function ()
     /**
      * Returns `true` if the given context has image smoothing enabled, otherwise returns `false`.
      * Returns null if no smoothing prefix is available.
+     *
+     * @function Phaser.Display.Canvas.Smoothing.isEnabled
+     * @since 3.0.0
+     * 
+     * @param {[type]} context - [description]
+     * 
+     * @return {boolean} [description]
      */
     var isEnabled = function (context)
     {
@@ -87,6 +120,7 @@ var Smoothing = function ()
         getPrefix: getPrefix,
         isEnabled: isEnabled
     };
+
 };
 
 module.exports = Smoothing();