Adding jsdocs

photonstorm · photonstorm · commit 7c9a5b41c715 · 2017-10-05T00:09:12.000+01:00
diff --git a/v3/src/animation/manager/AnimationManager.js b/v3/src/animation/manager/AnimationManager.js
@@ -1,6 +1,6 @@
 var Class = require('../../utils/Class');
 var EventDispatcher = require('../../events/EventDispatcher');
-var Map = require('../../structs/Map');
+var CustomMap = 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 all Game Objects.
@@ -60,7 +60,7 @@ var AnimationManager = new Class({
          * @property {Phaser.Structs.Map} anims
          * @protected
          */
-        this.anims = new Map();
+        this.anims = new CustomMap();
 
         /**
          * [description]
diff --git a/v3/src/animation/manager/events/AddAnimationEvent.js b/v3/src/animation/manager/events/AddAnimationEvent.js
@@ -7,6 +7,15 @@ var AddAnimationEvent = new Class({
 
     initialize:
 
+    /**
+     * [description]
+     *
+     * @event AddAnimationEvent
+     * @type {Phaser.Event}
+     *
+     * @param {string} key - [description]
+     * @param {Phaser.Animations.Animation} animation - [description]
+     */
     function AddAnimationEvent (key, animation)
     {
         Event.call(this, 'ADD_ANIMATION_EVENT');
diff --git a/v3/src/animation/manager/events/PauseAllAnimationEvent.js b/v3/src/animation/manager/events/PauseAllAnimationEvent.js
@@ -7,6 +7,12 @@ var PauseAllAnimationEvent = new Class({
 
     initialize:
 
+    /**
+     * [description]
+     *
+     * @event PauseAllAnimationEvent
+     * @type {Phaser.Event}
+     */
     function PauseAllAnimationEvent ()
     {
         Event.call(this, 'PAUSE_ALL_ANIMATION_EVENT');
diff --git a/v3/src/animation/manager/events/RemoveAnimationEvent.js b/v3/src/animation/manager/events/RemoveAnimationEvent.js
@@ -7,6 +7,15 @@ var RemoveAnimationEvent = new Class({
 
     initialize:
 
+    /**
+     * [description]
+     *
+     * @event RemoveAnimationEvent
+     * @type {Phaser.Event}
+     *
+     * @param {string} key - [description]
+     * @param {Phaser.Animations.Animation} animation - [description]
+     */
     function RemoveAnimationEvent (key, animation)
     {
         Event.call(this, 'REMOVE_ANIMATION_EVENT');
diff --git a/v3/src/animation/manager/events/ResumeAllAnimationEvent.js b/v3/src/animation/manager/events/ResumeAllAnimationEvent.js
@@ -7,6 +7,12 @@ var ResumeAllAnimationEvent = new Class({
 
     initialize:
 
+    /**
+     * [description]
+     *
+     * @event ResumeAllAnimationEvent
+     * @type {Phaser.Event}
+     */
     function ResumeAllAnimationEvent ()
     {
         Event.call(this, 'RESUME_ALL_ANIMATION_EVENT');
diff --git a/v3/src/animation/manager/inc/AddAnimation.js b/v3/src/animation/manager/inc/AddAnimation.js
@@ -4,6 +4,7 @@ var Event = require('../events/');
  * [description]
  *
  * @method Phaser.Animations.AnimationManager#add
+ * @fires AddAnimationEvent
  * @since 3.0.0
  * 
  * @param {string} key - [description]
diff --git a/v3/src/animation/manager/inc/CreateFrameAnimation.js b/v3/src/animation/manager/inc/CreateFrameAnimation.js
@@ -5,6 +5,7 @@ var Animation = require('../../frame/Animation');
  * [description]
  *
  * @method Phaser.Animations.AnimationManager#create
+ * @fires AddAnimationEvent
  * @since 3.0.0
  * 
  * @param {object} config - [description]
diff --git a/v3/src/animation/manager/inc/PauseAll.js b/v3/src/animation/manager/inc/PauseAll.js
@@ -4,6 +4,7 @@ var Event = require('../events/');
  * [description]
  *
  * @method Phaser.Animations.AnimationManager#pauseAll
+ * @fires PauseAllAnimationEvent
  * @since 3.0.0
  * 
  * @return {Phaser.Animations.AnimationManager} The Animation Manager for method chaining.
diff --git a/v3/src/animation/manager/inc/RemoveAnimation.js b/v3/src/animation/manager/inc/RemoveAnimation.js
@@ -4,6 +4,7 @@ var Event = require('../events/');
  * [description]
  *
  * @method Phaser.Animations.AnimationManager#remove
+ * @fires RemoveAnimationEvent
  * @since 3.0.0
  * 
  * @param {string} key - [description]
diff --git a/v3/src/animation/manager/inc/ResumeAll.js b/v3/src/animation/manager/inc/ResumeAll.js
@@ -4,6 +4,7 @@ var Event = require('../events/');
  * [description]
  *
  * @method Phaser.Animations.AnimationManager#resumeAll
+ * @fires ResumeAllAnimationEvent
  * @since 3.0.0
  * 
  * @return {Phaser.Animations.AnimationManager} The Animation Manager for method chaining.
diff --git a/v3/src/cache/BaseCache.js b/v3/src/cache/BaseCache.js
@@ -1,38 +1,91 @@
 var Class = require('../utils/Class');
+var CustomMap = require('../structs/Map');
 var EventDispatcher = require('../events/EventDispatcher');
 var Events = require('./events');
-var Map = require('../structs/Map');
-
-//  Phaser.Cache.BaseCache
 
 var BaseCache = new Class({
 
     initialize:
 
+    /**
+     * [description]
+     *
+     * @class BaseCache
+     * @memberOf Phaser.Cache
+     * @constructor
+     * @since 3.0.0
+     */
     function BaseCache ()
     {
-        this.entries = new Map();
+        /**
+         * [description]
+         *
+         * @property {Phaser.Structs.Map} entries
+         */
+        this.entries = new CustomMap();
 
+        /**
+         * [description]
+         *
+         * @property {Phaser.Events.EventDispatcher} events
+         */
         this.events = new EventDispatcher();
     },
 
+    /**
+     * [description]
+     *
+     * @method Phaser.Cache.BaseCache#add
+     * @fires CacheAddEvent
+     * @since 3.0.0
+     *
+     * @param {string} key [description]
+     * @param {any} data [description]
+     */
     add: function (key, data)
     {
         this.entries.set(key, data);
 
         this.events.dispatch(new Events.CACHE_ADD_EVENT(this, key, data));
     },
 
+    /**
+     * [description]
+     *
+     * @method Phaser.Cache.BaseCache#has
+     * @since 3.0.0
+     *
+     * @param {string} key [description]
+     * @return {boolean} [description]
+     */
     has: function (key)
     {
         return this.entries.has(key);
     },
 
+    /**
+     * [description]
+     *
+     * @method Phaser.Cache.BaseCache#get
+     * @since 3.0.0
+     *
+     * @param {string} key [description]
+     * @return {any} [description]
+     */
     get: function (key)
     {
         return this.entries.get(key);
     },
 
+    /**
+     * [description]
+     *
+     * @method Phaser.Cache.BaseCache#remove
+     * @fires CacheRemoveEvent
+     * @since 3.0.0
+     *
+     * @param {string} key [description]
+     */
     remove: function (key)
     {
         var entry = this.get(key);
@@ -45,6 +98,12 @@ var BaseCache = new Class({
         }
     },
 
+    /**
+     * [description]
+     *
+     * @method Phaser.Cache.BaseCache#destroy
+     * @since 3.0.0
+     */
     destroy: function ()
     {
         this.entries.clear();
diff --git a/v3/src/cache/GlobalCache.js b/v3/src/cache/GlobalCache.js
@@ -1,31 +1,130 @@
 var BaseCache = require('./BaseCache');
 var Class = require('../utils/Class');
 
-//  Phaser.Cache.GlobalCache
-
 var GlobalCache = new Class({
 
     initialize:
 
+    /**
+     * [description]
+     *
+     * @class GlobalCache
+     * @memberOf Phaser.Cache
+     * @constructor
+     * @since 3.0.0
+     * 
+     * @param {Phaser.Game} game - [description]
+     */
     function GlobalCache (game)
     {
+        /**
+         * [description]
+         *
+         * @property {Phaser.Game} game
+         * @protected
+         */
         this.game = game;
 
+        /**
+         * [description]
+         *
+         * @property {Phaser.Cache.BaseCache} binary
+         * @protected
+         */
         this.binary = new BaseCache();
+
+        /**
+         * [description]
+         *
+         * @property {Phaser.Cache.BaseCache} bitmapFont
+         * @protected
+         */
         this.bitmapFont = new BaseCache();
+
+        /**
+         * [description]
+         *
+         * @property {Phaser.Cache.BaseCache} json
+         * @protected
+         */
         this.json = new BaseCache();
+
+        /**
+         * [description]
+         *
+         * @property {Phaser.Cache.BaseCache} physics
+         * @protected
+         */
         this.physics = new BaseCache();
+
+        /**
+         * [description]
+         *
+         * @property {Phaser.Cache.BaseCache} shader
+         * @protected
+         */
         this.shader = new BaseCache();
+
+        /**
+         * [description]
+         *
+         * @property {Phaser.Cache.BaseCache} sound
+         * @protected
+         */
         this.sound = new BaseCache();
+
+        /**
+         * [description]
+         *
+         * @property {Phaser.Cache.BaseCache} text
+         * @protected
+         */
         this.text = new BaseCache();
+
+        /**
+         * [description]
+         *
+         * @property {Phaser.Cache.BaseCache} tilemap
+         * @protected
+         */
         this.tilemap = new BaseCache();
+
+        /**
+         * [description]
+         *
+         * @property {Phaser.Cache.BaseCache} video
+         * @protected
+         */
         this.video = new BaseCache();
+
+        /**
+         * [description]
+         *
+         * @property {Phaser.Cache.BaseCache} xml
+         * @protected
+         */
         this.xml = new BaseCache();
 
+        /**
+         * [description]
+         *
+         * @property {object.<Phaser.Cache.BaseCache>} custom
+         * @protected
+         */
         this.custom = {};
     },
 
     //  Add your own custom Cache entry, available under Cache.custom.key
+
+    /**
+     * [description]
+     *
+     * @method Phaser.Cache.GlobalCache#addCustom
+     * @since 3.0.0
+     * 
+     * @param {string} key - [description]
+     * @return {Phaser.Cache.BaseCache} [description]
+     */
     addCustom: function (key)
     {
         if (!this.custom.hasOwnProperty(key))
diff --git a/v3/src/cache/events/CacheAddEvent.js b/v3/src/cache/events/CacheAddEvent.js
@@ -7,6 +7,16 @@ var CacheAddEvent = new Class({
 
     initialize:
 
+    /**
+     * [description]
+     *
+     * @event CacheAddEvent
+     * @type {Phaser.Event}
+     *
+     * @param {Phaser.Cache.BaseCache} cache - [description]
+     * @param {string} key - [description]
+     * @param {any} data - [description]
+     */
     function CacheAddEvent (cache, key, data)
     {
         Event.call(this, 'CACHE_ADD_EVENT');
diff --git a/v3/src/cache/events/CacheRemoveEvent.js b/v3/src/cache/events/CacheRemoveEvent.js
@@ -7,6 +7,16 @@ var CacheRemoveEvent = new Class({
 
     initialize:
 
+    /**
+     * [description]
+     *
+     * @event CacheRemoveEvent
+     * @type {Phaser.Event}
+     *
+     * @param {Phaser.Cache.BaseCache} cache - [description]
+     * @param {string} key - [description]
+     * @param {any} data - [description]
+     */
     function CacheRemoveEvent (cache, key, data)
     {
         Event.call(this, 'CACHE_REMOVE_EVENT');

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ var Event = require('../events/');`
`4`	`4`	`* [description]`
`5`	`5`	`*`
`6`	`6`	`* @method Phaser.Animations.AnimationManager#add`
	`7`	`+ * @fires AddAnimationEvent`
`7`	`8`	`* @since 3.0.0`
`8`	`9`	`*`
`9`	`10`	`* @param {string} key - [description]`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ var Animation = require('../../frame/Animation');`
`5`	`5`	`* [description]`
`6`	`6`	`*`
`7`	`7`	`* @method Phaser.Animations.AnimationManager#create`
	`8`	`+ * @fires AddAnimationEvent`
`8`	`9`	`* @since 3.0.0`
`9`	`10`	`*`
`10`	`11`	`* @param {object} config - [description]`