Moving all of the typedefs to properly namespaced scopes, rather than globals

\o/ ~ "Someone, save me!"

Author: photonstorm

src/actions/GridAlign.js

@@ -12,20 +12,6 @@ var Zone = require('../gameobjects/zone/Zone');
 
 var tempZone = new Zone({ sys: { queueDepthSort: NOOP, events: { once: NOOP } } }, 0, 0, 1, 1);
 
-/**
- * @typedef {object} GridAlignConfig
- *
- * @property {integer} [width=-1] - The width of the grid in items (not pixels). -1 means lay all items out horizontally, regardless of quantity.
- *                                  If both this value and height are set to -1 then this value overrides it and the `height` value is ignored.
- * @property {integer} [height=-1] - The height of the grid in items (not pixels). -1 means lay all items out vertically, regardless of quantity.
- *                                   If both this value and `width` are set to -1 then `width` overrides it and this value is ignored.
- * @property {integer} [cellWidth=1] - The width of the cell, in pixels, in which the item is positioned.
- * @property {integer} [cellHeight=1] - The height of the cell, in pixels, in which the item is positioned.
- * @property {integer} [position=0] - The alignment position. One of the Phaser.Display.Align consts such as `TOP_LEFT` or `RIGHT_CENTER`.
- * @property {number} [x=0] - Optionally place the top-left of the final grid at this coordinate.
- * @property {number} [y=0] - Optionally place the top-left of the final grid at this coordinate.
- */
-
 /**
  * Takes an array of Game Objects, or any objects that have public `x` and `y` properties,
  * and then aligns them based on the grid configuration given to this action.
@@ -36,7 +22,7 @@ var tempZone = new Zone({ sys: { queueDepthSort: NOOP, events: { once: NOOP } }
  * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]
  *
  * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
- * @param {GridAlignConfig} options - The GridAlign Configuration object.
+ * @param {Phaser.Actions.Types.GridAlignConfig} options - The GridAlign Configuration object.
  *
  * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.
  */

src/actions/typedefs/GridAlignConfig.js

@@ -0,0 +1,14 @@
+/**
+ * @typedef {object} Phaser.Actions.Types.GridAlignConfig
+ * @since 3.0.0
+ *
+ * @property {integer} [width=-1] - The width of the grid in items (not pixels). -1 means lay all items out horizontally, regardless of quantity.
+ *                                  If both this value and height are set to -1 then this value overrides it and the `height` value is ignored.
+ * @property {integer} [height=-1] - The height of the grid in items (not pixels). -1 means lay all items out vertically, regardless of quantity.
+ *                                   If both this value and `width` are set to -1 then `width` overrides it and this value is ignored.
+ * @property {integer} [cellWidth=1] - The width of the cell, in pixels, in which the item is positioned.
+ * @property {integer} [cellHeight=1] - The height of the cell, in pixels, in which the item is positioned.
+ * @property {integer} [position=0] - The alignment position. One of the Phaser.Display.Align consts such as `TOP_LEFT` or `RIGHT_CENTER`.
+ * @property {number} [x=0] - Optionally place the top-left of the final grid at this coordinate.
+ * @property {number} [y=0] - Optionally place the top-left of the final grid at this coordinate.
+ */

src/actions/typedefs/GroupCallback.js

@@ -0,0 +1,6 @@
+/**
+ * @callback Phaser.GameObjects.Group.Types.GroupCallback
+ * @since 3.0.0
+ *
+ * @param {Phaser.GameObjects.GameObject} item - A group member
+ */

src/actions/typedefs/GroupClassTypeConstructor.js

@@ -0,0 +1,14 @@
+/**
+ * A constructor function (class) that can be assigned to `classType`.
+ * 
+ * @callback Phaser.GameObjects.Group.Types.GroupClassTypeConstructor
+ * @since 3.0.0
+ * 
+ * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.
+ * @param {number} x - The horizontal position of this Game Object in the world.
+ * @param {number} y - The vertical position of this Game Object in the world.
+ * @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
+ * @param {(string|integer)} [frame] - An optional frame from the Texture this Game Object is rendering with.
+ *
+ * @see Phaser.GameObjects.Group#classType
+ */

src/actions/typedefs/GroupMultipleCreateCallback.js

@@ -0,0 +1,6 @@
+/**
+ * @callback Phaser.GameObjects.Group.Types.GroupMultipleCreateCallback
+ * @since 3.0.0
+ *
+ * @param {Phaser.GameObjects.GameObject[]} items - The newly created group members
+ */

src/actions/typedefs/index.js

@@ -0,0 +1,9 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+ */
+
+/**
+ * @namespace Phaser.Actions.Types
+ */

src/animations/typedefs/Animation.js

@@ -1,5 +1,6 @@
 /**
  * @typedef {object} Phaser.Animations.Types.Animation
+ * @since 3.0.0
  *
  * @property {string} [key] - The key that the animation will be associated with. i.e. sprite.animations.play(key)
  * @property {Phaser.Animations.Types.AnimationFrame[]} [frames] - An object containing data used to generate the frames for the animation

src/animations/typedefs/AnimationFrame.js

@@ -1,5 +1,6 @@
 /**
  * @typedef {object} Phaser.Animations.Types.AnimationFrame
+ * @since 3.0.0
  *
  * @property {string} key - The key that the animation will be associated with. i.e. sprite.animations.play(key)
  * @property {(string|number)} frame - [description]

src/animations/typedefs/GenerateFrameNames.js

@@ -1,5 +1,6 @@
 /**
  * @typedef {object} Phaser.Animations.Types.GenerateFrameNames
+ * @since 3.0.0
  *
  * @property {string} [prefix=''] - The string to append to every resulting frame name if using a range or an array of `frames`.
  * @property {integer} [start=0] - If `frames` is not provided, the number of the first frame to return.

src/animations/typedefs/GenerateFrameNumbers.js

@@ -1,5 +1,6 @@
 /**
  * @typedef {object} Phaser.Animations.Types.GenerateFrameNumbers
+ * @since 3.0.0
  *
  * @property {integer} [start=0] - The starting frame of the animation.
  * @property {integer} [end=-1] - The ending frame of the animation.