Removing old and incorrect jsdoc blocks ready for first documentation pass.

Author: photonstorm

v3/src/actions/GridAlign.js

@@ -5,57 +5,6 @@ var GetValue = require('../utils/object/GetValue');
 
 var tempZone = new Zone({ sys: { sortChildrenFlag: false }}, 0, 0, 1, 1);
 
-/**
-* This method iterates through all children in the Group (regardless if they are visible or exist)
-* and then changes their position so they are arranged in a Grid formation. Children must have
-* the `alignTo` method in order to be positioned by this call. All default Phaser Game Objects have
-* this.
-*
-* The grid dimensions are determined by the first four arguments. The `width` and `height` arguments
-* relate to the width and height of the grid respectively.
-*
-* For example if the Group had 100 children in it:
-*
-* `Group.align(10, 10, 32, 32)`
-*
-* This will align all of the children into a grid formation of 10x10, using 32 pixels per
-* grid cell. If you want a wider grid, you could do:
-* 
-* `Group.align(25, 4, 32, 32)`
-*
-* This will align the children into a grid of 25x4, again using 32 pixels per grid cell.
-*
-* You can choose to set _either_ the `width` or `height` value to -1. Doing so tells the method
-* to keep on aligning children until there are no children left. For example if this Group had
-* 48 children in it, the following:
-*
-* `Group.align(-1, 8, 32, 32)`
-*
-* ... will align the children so that there are 8 children vertically (the second argument), 
-* and each row will contain 6 sprites, except the last one, which will contain 5 (totaling 48)
-*
-* You can also do:
-* 
-* `Group.align(10, -1, 32, 32)`
-*
-* In this case it will create a grid 10 wide, and as tall as it needs to be in order to fit
-* all of the children in.
-*
-* The `position` property allows you to control where in each grid cell the child is positioned.
-* This is a constant and can be one of `Phaser.TOP_LEFT` (default), `Phaser.TOP_CENTER`, 
-* `Phaser.TOP_RIGHT`, `Phaser.LEFT_CENTER`, `Phaser.CENTER`, `Phaser.RIGHT_CENTER`, 
-* `Phaser.BOTTOM_LEFT`, `Phaser.BOTTOM_CENTER` or `Phaser.BOTTOM_RIGHT`.
-*
-* The final argument; `offset` lets you start the alignment from a specific child index.
-*
-* @method Phaser.Group#align
-* @param {integer} width - The width of the grid in items (not pixels). Set to -1 for a dynamic width. If -1 then you must set an explicit height value.
-* @param {integer} height - The height of the grid in items (not pixels). Set to -1 for a dynamic height. If -1 then you must set an explicit width value.
-* @param {integer} cellWidth - The width of each grid cell, in pixels.
-* @param {integer} cellHeight - The height of each grid cell, in pixels.
-* @param {integer} [position] - The position constant. One of `Phaser.TOP_LEFT` (default), `Phaser.TOP_CENTER`, `Phaser.TOP_RIGHT`, `Phaser.LEFT_CENTER`, `Phaser.CENTER`, `Phaser.RIGHT_CENTER`, `Phaser.BOTTOM_LEFT`, `Phaser.BOTTOM_CENTER` or `Phaser.BOTTOM_RIGHT`.
-* @return {boolean} True if the Group children were aligned, otherwise false.
-*/
 var GridAlign = function (items, options)
 {
     var width = GetValue(options, 'width', -1);

v3/src/animation/manager/AnimationManager.js

@@ -1,25 +1,13 @@
-/**
-* @author       Richard Davey <rich@photonstorm.com>
-* @copyright    2016 Photon Storm Ltd.
-* @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
-*/
-
 var Class = require('../../utils/Class');
 var Components = require('./components/');
 var EventDispatcher = require('../../events/EventDispatcher');
 var Map = require('../../structs/Map');
 
-/**
-* Animations are managed by the global AnimationManager. This is a singleton class that is
-* responsible for creating and delivering animations and their corresponding data to Game Objects.
-*
-* Sprites and other Game Objects get the data they need from the AnimationManager.
-*
-* Access it via `scene.anims`.
-*
-* @class Phaser.AnimationManager
-* @constructor
-*/
+// Animations are managed by the global AnimationManager. This is a singleton class that is
+// responsible for creating and delivering animations and their corresponding data to Game Objects.
+// Sprites and other Game Objects get the data they need from the AnimationManager.
+// Access it via `scene.anims`.
+
 var AnimationManager = new Class({
 
     initialize:

v3/src/boot/Config.js

@@ -1,9 +1,3 @@
-/**
-* @author       Richard Davey <rich@photonstorm.com>
-* @copyright    2016 Photon Storm Ltd.
-* @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
-*/
-
 var Class = require('../utils/Class');
 var CONST = require('../const');
 var GetValue = require('../utils/object/GetValue');

v3/src/boot/CreateRenderer.js

@@ -1,22 +1,10 @@
-/**
-* @author       Richard Davey <rich@photonstorm.com>
-* @copyright    2016 Photon Storm Ltd.
-* @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
-*/
-
 var CONST = require('../const');
 var CanvasPool = require('../dom/CanvasPool');
 var Features = require('../device/Features');
 var CanvasRenderer = require('../renderer/canvas/CanvasRenderer');
 var WebGLRenderer = require('../renderer/webgl/WebGLRenderer');
 var CanvasInterpolation = require('../dom/CanvasInterpolation');
 
-/**
-* Checks if the device is capable of using the requested renderer and sets it up or an alternative if not.
-*
-* @method Phaser.Game#setUpRenderer
-* @protected
-*/
 var CreateRenderer = function (game)
 {
     var config = game.config;

v3/src/boot/DebugHeader.js

@@ -1,9 +1,3 @@
-/**
-* @author       Richard Davey <rich@photonstorm.com>
-* @copyright    2016 Photon Storm Ltd.
-* @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
-*/
-
 var CONST = require('../const');
 var CHECKSUM = require('../checksum');
 

v3/src/boot/Game.js

@@ -1,4 +1,3 @@
-
 var Class = require('../utils/Class');
 var Config = require('./Config');
 var DebugHeader = require('./DebugHeader');
@@ -34,50 +33,22 @@ var Game = new Class({
         this.isBooted = false;
         this.isRunning = false;
 
-        /**
-        * @property {EventDispatcher} events - Global / Global Game System Events
-        */
         this.events = new EventDispatcher();
 
-        /**
-        * @property {Phaser.AnimationManager} anims - Reference to the Phaser Animation Manager.
-        */
         this.anims = new AnimationManager(this);
 
-        /**
-        * @property {Phaser.TextureManager} textures - Reference to the Phaser Texture Manager.
-        */
         this.textures = new TextureManager(this);
 
-        /**
-        * @property {Phaser.Cache} cache - Reference to the assets cache.
-        */
         this.cache = new GlobalCache(this);
 
-        /**
-        * @property {Phaser.Data} registry - Game wide data store.
-        */
         this.registry = new Data(this);
 
-        /**
-        * @property {Phaser.Input} input - Reference to the input manager
-        */
         this.input = new GlobalInputManager(this, this.config);
 
-        /**
-        * @property {Phaser.GlobalSceneManager} scene - The SceneManager. Phaser instance specific.
-        */
         this.scene = new GlobalSceneManager(this, this.config.sceneConfig);
 
-        /**
-        * @property {Phaser.Device} device - Contains device information and capabilities (singleton)
-        */
         this.device = Device;
 
-        /**
-        * @property {Phaser.MainLoop} mainloop - Main Loop handler.
-        * @protected
-        */
         this.loop = new TimeStep(this, this.config.fps);
 
         this.onStepCallback = NOOP;

v3/src/camera/components/SetScroll.js

@@ -1,4 +1,4 @@
-var setScroll = function (x, y)
+var SetScroll = function (x, y)
 {
     if (y === undefined) { y = x; }
 
@@ -8,4 +8,4 @@ var setScroll = function (x, y)
     return this;
 };
 
-module.exports = setScroll;
+module.exports = SetScroll;

v3/src/create/palettes/Arne16.js

@@ -1,24 +1,20 @@
-/**
-* A 16 color palette by [Arne](http://androidarts.com/palette/16pal.htm)
-* @constant
-* @type {Array}
-*/
+// A 16 color palette by [Arne](http://androidarts.com/palette/16pal.htm)
 
 module.exports = {
-    0: '#000', 
-    1: '#9D9D9D', 
-    2: '#FFF', 
-    3: '#BE2633', 
-    4: '#E06F8B', 
-    5: '#493C2B', 
-    6: '#A46422', 
-    7: '#EB8931', 
-    8: '#F7E26B', 
-    9: '#2F484E', 
-    A: '#44891A', 
-    B: '#A3CE27', 
-    C: '#1B2632', 
-    D: '#005784', 
-    E: '#31A2F2', 
+    0: '#000',
+    1: '#9D9D9D',
+    2: '#FFF',
+    3: '#BE2633',
+    4: '#E06F8B',
+    5: '#493C2B',
+    6: '#A46422',
+    7: '#EB8931',
+    8: '#F7E26B',
+    9: '#2F484E',
+    A: '#44891A',
+    B: '#A3CE27',
+    C: '#1B2632',
+    D: '#005784',
+    E: '#31A2F2',
     F: '#B2DCEF'
 };

v3/src/create/palettes/C64.js

@@ -1,8 +1,4 @@
-/**
-* A 16 color C64 inspired palette.
-* @constant
-* @type {Array}
-*/
+// A 16 color C64 inspired palette.
 
 module.exports = {
     0: '#000',

v3/src/create/palettes/CGA.js

@@ -1,8 +1,4 @@
-/**
-* A 16 color CGA inspired palette by [Arne](http://androidarts.com/palette/16pal.htm)
-* @constant
-* @type {Array}
-*/
+// A 16 color CGA inspired palette by [Arne](http://androidarts.com/palette/16pal.htm)
 
 module.exports = {
     0: '#000',