Merge pull request phaserjs#3453 from orblazer/genericTypes

Change structs for generic types

Author: photonstorm

.gitignore

@@ -2,6 +2,7 @@
 Thumbs.db
 .DS_Store
 .idea
+.vscode
 *.suo
 *.sublime-project
 *.sublime-workspace

src/animations/AnimationManager.js

@@ -80,7 +80,7 @@ var AnimationManager = new Class({
          * [description]
          *
          * @name Phaser.Animations.AnimationManager#anims
-         * @type {Phaser.Structs.Map}
+         * @type {Phaser.Structs.Map<string, Phaser.Animations.Animation>}
          * @protected
          * @since 3.0.0
          */

src/cache/BaseCache.js

@@ -33,7 +33,7 @@ var BaseCache = new Class({
          * You can query the Map directly or use the BaseCache methods.
          *
          * @name Phaser.Cache.BaseCache#entries
-         * @type {Phaser.Structs.Map}
+         * @type {Phaser.Structs.Map.<String, *>}
          * @since 3.0.0
          */
         this.entries = new CustomMap();
@@ -54,9 +54,9 @@ var BaseCache = new Class({
      * This event is fired by the Cache each time a new object is added to it.
      *
      * @event Phaser.Cache.BaseCache#addEvent
-     * @param {Phaser.Cache.BaseCache} The BaseCache to which the object was added.
-     * @param {string} The key of the object added to the cache.
-     * @param {*} A reference to the object added to the cache.
+     * @param {Phaser.Cache.BaseCache} base - The BaseCache to which the object was added.
+     * @param {string} key - The key of the object added to the cache.
+     * @param {*} object - A reference to the object added to the cache.
      */
 
     /**

src/cache/CacheManager.js

@@ -10,7 +10,7 @@ var Class = require('../utils/Class');
 /**
  * @classdesc
  * The Cache Manager is the global cache owned and maintained by the Game instance.
- * 
+ *
  * Various systems, such as the file Loader, rely on this cache in order to store the files
  * it has loaded. The manager itself doesn't store any files, but instead owns multiple BaseCache
  * instances, one per type of file. You can also add your own custom caches.
@@ -145,7 +145,7 @@ var CacheManager = new Class({
          * Add to this via the `addCustom` method.
          *
          * @name Phaser.Cache.CacheManager#custom
-         * @type {object.<Phaser.Cache.BaseCache>}
+         * @type {Object.<Phaser.Cache.BaseCache>}
          * @protected
          * @since 3.0.0
          */

src/gameobjects/blitter/Blitter.js

@@ -90,7 +90,7 @@ var Blitter = new Class({
          * [description]
          *
          * @name Phaser.GameObjects.Blitter#children
-         * @type {Phaser.Structs.List}
+         * @type {Phaser.Structs.List.<Phaser.GameObjects.Blitter.Blitter>}
          * @since 3.0.0
          */
         this.children = new List();
@@ -153,7 +153,7 @@ var Blitter = new Class({
      *
      * @param {BlitterFromCallback} callback - The callback to invoke after creating a bob. It will be sent two arguments: The Bob and the index of the Bob.
      * @param {integer} quantity - The quantity of Bob objects to create.
-     * @param {string} [frame] - The Frame the Bobs will use. It must be part of the Blitter Texture.
+     * @param {(string|integer|Phaser.Textures.Frame|string[]|integer[]|Phaser.Textures.Frame[])} [frame] - The Frame the Bobs will use. It must be part of the Blitter Texture.
      * @param {boolean} [visible=true] - [description]
      *
      * @return {Phaser.GameObjects.Blitter.Bob[]} An array of Bob objects that were created.
@@ -179,7 +179,7 @@ var Blitter = new Class({
      * @since 3.0.0
      *
      * @param {integer} quantity - The quantity of Bob objects to create.
-     * @param {string} [frame] - The Frame the Bobs will use. It must be part of the Blitter Texture.
+     * @param {(string|integer|Phaser.Textures.Frame|string[]|integer[]|Phaser.Textures.Frame[])} [frame] - The Frame the Bobs will use. It must be part of the Blitter Texture.
      * @param {boolean} [visible=true] - [description]
      *
      * @return {Phaser.GameObjects.Blitter.Bob[]} An array of Bob objects that were created.

src/gameobjects/group/Group.js

@@ -86,7 +86,7 @@ var Sprite = require('../sprite/Sprite');
  * @since 3.0.0
  *
  * @param {Phaser.Scene} scene - [description]
- * @param {array} children - [description]
+ * @param {Phaser.GameObjects.GameObject[]} children - [description]
  * @param {GroupConfig} config - [description]
  */
 var Group = new Class({
@@ -114,7 +114,7 @@ var Group = new Class({
          * [description]
          *
          * @name Phaser.GameObjects.Group#children
-         * @type {Phaser.Structs.Set}
+         * @type {Phaser.Structs.Set.<Phaser.GameObjects.GameObject>}
          * @since 3.0.0
          */
         this.children = new Set(children);

src/gameobjects/particles/ParticleEmitterManager.js

@@ -114,7 +114,7 @@ var ParticleEmitterManager = new Class({
          * A list of Emitters being managed by this Emitter Manager.
          *
          * @name Phaser.GameObjects.Particles.ParticleEmitterManager#emitters
-         * @type {Phaser.Structs.List}
+             * @type {Phaser.Structs.List.<Phaser.GameObjects.Particles.ParticleEmitter>}
          * @since 3.0.0
          */
         this.emitters = new List(this);
@@ -123,7 +123,7 @@ var ParticleEmitterManager = new Class({
          * A list of Gravity Wells being managed by this Emitter Manager.
          *
          * @name Phaser.GameObjects.Particles.ParticleEmitterManager#wells
-         * @type {Phaser.Structs.List}
+         * @type {Phaser.Structs.List.<Phaser.GameObjects.Particles.GravityWell>}
          * @since 3.0.0
          */
         this.wells = new List(this);

src/loader/LoaderPlugin.js

@@ -14,6 +14,14 @@ var ParseXMLBitmapFont = require('../gameobjects/bitmaptext/ParseXMLBitmapFont')
 var PluginManager = require('../boot/PluginManager');
 var XHRSettings = require('./XHRSettings');
 
+/**
+ * @typedef {object} LinkFileObject
+ *
+ * @property {string} type - [description]
+ * @property {Phaser.Loader.File} fileA - [description]
+ * @property {Phaser.Loader.File} fileB - [description]
+ */
+
 /**
  * @typedef {object} LoaderFileObject
  *
@@ -188,7 +196,7 @@ var LoaderPlugin = new Class({
          * [description]
          *
          * @name Phaser.Loader.LoaderPlugin#list
-         * @type {Phaser.Structs.Set}
+         * @type {Phaser.Structs.Set.<Phaser.Loader.File>}
          * @since 3.0.0
          */
         this.list = new CustomSet();
@@ -197,7 +205,7 @@ var LoaderPlugin = new Class({
          * [description]
          *
          * @name Phaser.Loader.LoaderPlugin#inflight
-         * @type {Phaser.Structs.Set}
+         * @type {Phaser.Structs.Set.<Phaser.Loader.File>}
          * @since 3.0.0
          */
         this.inflight = new CustomSet();
@@ -206,7 +214,7 @@ var LoaderPlugin = new Class({
          * [description]
          *
          * @name Phaser.Loader.LoaderPlugin#failed
-         * @type {Phaser.Structs.Set}
+         * @type {Phaser.Structs.Set.<Phaser.Loader.File>}
          * @since 3.0.0
          */
         this.failed = new CustomSet();
@@ -215,7 +223,7 @@ var LoaderPlugin = new Class({
          * [description]
          *
          * @name Phaser.Loader.LoaderPlugin#queue
-         * @type {Phaser.Structs.Set}
+         * @type {Phaser.Structs.Set.<Phaser.Loader.File>}
          * @since 3.0.0
          */
         this.queue = new CustomSet();
@@ -224,7 +232,7 @@ var LoaderPlugin = new Class({
          * [description]
          *
          * @name Phaser.Loader.LoaderPlugin#storage
-         * @type {Phaser.Structs.Set}
+         * @type {Phaser.Structs.Set.<(Phaser.Loader.File|LinkFileObject)>}
          * @since 3.0.0
          */
         this.storage = new CustomSet();

src/physics/arcade/World.js

@@ -121,7 +121,7 @@ var World = new Class({
          * Dynamic Bodies
          *
          * @name Phaser.Physics.Arcade.World#bodies
-         * @type {Phaser.Structs.Set}
+         * @type {Phaser.Structs.Set.<Phaser.Physics.Arcade.Body>}
          * @since 3.0.0
          */
         this.bodies = new Set();
@@ -130,7 +130,7 @@ var World = new Class({
          * Static Bodies
          *
          * @name Phaser.Physics.Arcade.World#staticBodies
-         * @type {Phaser.Structs.Set}
+         * @type {Phaser.Structs.Set.<Phaser.Physics.Arcade.StaticBody>}
          * @since 3.0.0
          */
         this.staticBodies = new Set();
@@ -139,7 +139,7 @@ var World = new Class({
          * Static Bodies
          *
          * @name Phaser.Physics.Arcade.World#pendingDestroy
-         * @type {Phaser.Structs.Set}
+         * @type {Phaser.Structs.Set.<(Phaser.Physics.Arcade.Body|Phaser.Physics.Arcade.StaticBody)>}
          * @since 3.1.0
          */
         this.pendingDestroy = new Set();
@@ -148,7 +148,7 @@ var World = new Class({
          * [description]
          *
          * @name Phaser.Physics.Arcade.World#colliders
-         * @type {Phaser.Structs.ProcessQueue}
+         * @type {Phaser.Structs.ProcessQueue.<Phaser.Physics.Arcade.Collider>}
          * @since 3.0.0
          */
         this.colliders = new ProcessQueue();

src/physics/impact/World.js

@@ -108,7 +108,7 @@ var World = new Class({
          * [description]
          *
          * @name Phaser.Physics.Impact.World#bodies
-         * @type {Phaser.Structs.Set}
+         * @type {Phaser.Structs.Set.<Phaser.Physics.Impact.Body>}
          * @since 3.0.0
          */
         this.bodies = new Set();