Documented the ScenePlugin class.

hexus · hexus · commit e047977f5251 · 2018-04-02T18:29:23.000+01:00
diff --git a/src/scene/SceneManager.js b/src/scene/SceneManager.js
@@ -890,7 +890,7 @@ var SceneManager = new Class({
      * @method Phaser.Scenes.SceneManager#sleep
      * @since 3.0.0
      *
-     * @param {string} key - The Scene to sleep.
+     * @param {string} key - The Scene to put to sleep.
      *
      * @return {Phaser.Scenes.SceneManager} This SceneManager.
      */
@@ -935,7 +935,7 @@ var SceneManager = new Class({
      * @since 3.0.0
      *
      * @param {string} key - The Scene to start.
-     * @param {object} [data] - Scene config data.
+     * @param {object} [data] - The Scene data.
      *
      * @return {Phaser.Scenes.SceneManager} This SceneManager.
      */
@@ -1091,7 +1091,7 @@ var SceneManager = new Class({
      * @method Phaser.Scenes.SceneManager#bringToTop
      * @since 3.0.0
      *
-     * @param {(string|Phaser.Scene)} key - The Scene to affect.
+     * @param {(string|Phaser.Scene)} key - The Scene to move.
      *
      * @return {Phaser.Scenes.SceneManager} This SceneManager.
      */
@@ -1125,7 +1125,7 @@ var SceneManager = new Class({
      * @method Phaser.Scenes.SceneManager#sendToBack
      * @since 3.0.0
      *
-     * @param {(string|Phaser.Scene)} key - The Scene to affect.
+     * @param {(string|Phaser.Scene)} key - The Scene to move.
      *
      * @return {Phaser.Scenes.SceneManager} This SceneManager.
      */
@@ -1157,7 +1157,7 @@ var SceneManager = new Class({
      * @method Phaser.Scenes.SceneManager#moveDown
      * @since 3.0.0
      *
-     * @param {(string|Phaser.Scene)} key - The Scene to affect.
+     * @param {(string|Phaser.Scene)} key - The Scene to move.
      *
      * @return {Phaser.Scenes.SceneManager} This SceneManager.
      */
@@ -1191,7 +1191,7 @@ var SceneManager = new Class({
      * @method Phaser.Scenes.SceneManager#moveUp
      * @since 3.0.0
      *
-     * @param {(string|Phaser.Scene)} key - The Scene to affect.
+     * @param {(string|Phaser.Scene)} key - The Scene to move.
      *
      * @return {Phaser.Scenes.SceneManager} This SceneManager.
      */
diff --git a/src/scene/ScenePlugin.js b/src/scene/ScenePlugin.js
@@ -17,7 +17,7 @@ var PluginManager = require('../boot/PluginManager');
  * @constructor
  * @since 3.0.0
  *
- * @param {Phaser.Scene} scene - [description]
+ * @param {Phaser.Scene} scene - The Scene that this ScenePlugin belongs to.
  */
 var ScenePlugin = new Class({
 
@@ -26,7 +26,7 @@ var ScenePlugin = new Class({
     function ScenePlugin (scene)
     {
         /**
-         * [description]
+         * The Scene that this ScenePlugin belongs to.
          *
          * @name Phaser.Scenes.ScenePlugin#scene
          * @type {Phaser.Scene}
@@ -35,7 +35,7 @@ var ScenePlugin = new Class({
         this.scene = scene;
 
         /**
-         * [description]
+         * The Scene Systems instance of the Scene that this ScenePlugin belongs to.
          *
          * @name Phaser.Scenes.ScenePlugin#systems
          * @type {Phaser.Scenes.Systems}
@@ -49,7 +49,7 @@ var ScenePlugin = new Class({
         }
 
         /**
-         * [description]
+         * The settings of the Scene this ScenePlugin belongs to.
          *
          * @name Phaser.Scenes.ScenePlugin#settings
          * @type {SettingsObject}
@@ -58,7 +58,7 @@ var ScenePlugin = new Class({
         this.settings = scene.sys.settings;
 
         /**
-         * [description]
+         * The key of the Scene this ScenePlugin belongs to.
          *
          * @name Phaser.Scenes.ScenePlugin#key
          * @type {string}
@@ -67,7 +67,7 @@ var ScenePlugin = new Class({
         this.key = scene.sys.settings.key;
 
         /**
-         * [description]
+         * The Game's SceneManager.
          *
          * @name Phaser.Scenes.ScenePlugin#manager
          * @type {Phaser.Scenes.SceneManager}
@@ -77,7 +77,9 @@ var ScenePlugin = new Class({
     },
 
     /**
-     * [description]
+     * Boot the ScenePlugin.
+     *
+     * Registers event handlers.
      *
      * @method Phaser.Scenes.ScenePlugin#boot
      * @since 3.0.0
@@ -96,8 +98,8 @@ var ScenePlugin = new Class({
      * @method Phaser.Scenes.ScenePlugin#start
      * @since 3.0.0
      *
-     * @param {string} key - [description]
-     * @param {object} [data] - [description]
+     * @param {string} key - The Scene to start.
+     * @param {object} [data] - The Scene data.
      *
      * @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.
      */
@@ -125,9 +127,9 @@ var ScenePlugin = new Class({
      * @method Phaser.Scenes.ScenePlugin#add
      * @since 3.0.0
      *
-     * @param {string} key - [description]
-     * @param {object} sceneConfig - [description]
-     * @param {boolean} autoStart - [description]
+     * @param {string} key - The Scene key.
+     * @param {(Phaser.Scene|SettingsConfig|function)} sceneConfig - The config for the Scene.
+     * @param {boolean} autoStart - Whether to start the Scene after it's added.
      *
      * @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.
      */
@@ -144,8 +146,8 @@ var ScenePlugin = new Class({
      * @method Phaser.Scenes.ScenePlugin#launch
      * @since 3.0.0
      *
-     * @param {string} key - [description]
-     * @param {object} [data] - [description]
+     * @param {string} key - The Scene to launch.
+     * @param {object} [data] - The Scene data.
      *
      * @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.
      */
@@ -172,7 +174,7 @@ var ScenePlugin = new Class({
      * @method Phaser.Scenes.ScenePlugin#pause
      * @since 3.0.0
      *
-     * @param {string} key - [description]
+     * @param {string} key - The Scene to pause.
      *
      * @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.
      */
@@ -191,7 +193,7 @@ var ScenePlugin = new Class({
      * @method Phaser.Scenes.ScenePlugin#resume
      * @since 3.0.0
      *
-     * @param {string} key - [description]
+     * @param {string} key - The Scene to resume.
      *
      * @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.
      */
@@ -210,7 +212,7 @@ var ScenePlugin = new Class({
      * @method Phaser.Scenes.ScenePlugin#sleep
      * @since 3.0.0
      *
-     * @param {string} key - [description]
+     * @param {string} key - The Scene to put to sleep.
      *
      * @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.
      */
@@ -229,7 +231,7 @@ var ScenePlugin = new Class({
      * @method Phaser.Scenes.ScenePlugin#wake
      * @since 3.0.0
      *
-     * @param {string} key - [description]
+     * @param {string} key - The Scene to wake up.
      *
      * @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.
      */
@@ -248,7 +250,7 @@ var ScenePlugin = new Class({
      * @method Phaser.Scenes.ScenePlugin#switch
      * @since 3.0.0
      *
-     * @param {string} key - [description]
+     * @param {string} key - The Scene to start.
      *
      * @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.
      */
@@ -275,7 +277,7 @@ var ScenePlugin = new Class({
      * @method Phaser.Scenes.ScenePlugin#stop
      * @since 3.0.0
      *
-     * @param {string} key - [description]
+     * @param {string} key - The Scene to stop.
      *
      * @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.
      */
@@ -294,7 +296,7 @@ var ScenePlugin = new Class({
      * @method Phaser.Scenes.ScenePlugin#setActive
      * @since 3.0.0
      *
-     * @param {boolean} value - [description]
+     * @param {boolean} value - The Scene to set the active state for.
      *
      * @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.
      */
@@ -311,7 +313,7 @@ var ScenePlugin = new Class({
      * @method Phaser.Scenes.ScenePlugin#setVisible
      * @since 3.0.0
      *
-     * @param {boolean} value - [description]
+     * @param {boolean} value - The Scene to set the visible state for.
      *
      * @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.
      */
@@ -328,9 +330,9 @@ var ScenePlugin = new Class({
      * @method Phaser.Scenes.ScenePlugin#isSleeping
      * @since 3.0.0
      *
-     * @param {string} key - [description]
+     * @param {string} key - The Scene to check.
      *
-     * @return {boolean} [description]
+     * @return {boolean} Whether the Scene is sleeping.
      */
     isSleeping: function (key)
     {
@@ -345,9 +347,9 @@ var ScenePlugin = new Class({
      * @method Phaser.Scenes.ScenePlugin#isActive
      * @since 3.0.0
      *
-     * @param {string} key - [description]
+     * @param {string} key - The Scene to check.
      *
-     * @return {boolean} [description]
+     * @return {boolean} Whether the Scene is active.
      */
     isActive: function (key)
     {
@@ -362,9 +364,9 @@ var ScenePlugin = new Class({
      * @method Phaser.Scenes.ScenePlugin#isVisible
      * @since 3.0.0
      *
-     * @param {string} key - [description]
+     * @param {string} key - The Scene to check.
      *
-     * @return {boolean} [description]
+     * @return {boolean} Whether the Scene is visible.
      */
     isVisible: function (key)
     {
@@ -375,6 +377,7 @@ var ScenePlugin = new Class({
 
     /**
      * Swaps the position of two scenes in the Scenes list.
+     *
      * This controls the order in which they are rendered and updated.
      *
      * @method Phaser.Scenes.ScenePlugin#swapPosition
@@ -399,6 +402,7 @@ var ScenePlugin = new Class({
 
     /**
      * Swaps the position of two scenes in the Scenes list, so that Scene B is directly above Scene A.
+     *
      * This controls the order in which they are rendered and updated.
      *
      * @method Phaser.Scenes.ScenePlugin#moveAbove
@@ -423,6 +427,7 @@ var ScenePlugin = new Class({
 
     /**
      * Swaps the position of two scenes in the Scenes list, so that Scene B is directly below Scene A.
+     *
      * This controls the order in which they are rendered and updated.
      *
      * @method Phaser.Scenes.ScenePlugin#moveBelow
@@ -457,7 +462,7 @@ var ScenePlugin = new Class({
      * @method Phaser.Scenes.ScenePlugin#remove
      * @since 3.2.0
      *
-     * @param {(string|Phaser.Scene)} scene - The Scene to be removed.
+     * @param {(string|Phaser.Scene)} key - The Scene to be removed.
      *
      * @return {Phaser.Scenes.SceneManager} This SceneManager.
      */
@@ -471,12 +476,12 @@ var ScenePlugin = new Class({
     },
 
     /**
-     * [description]
+     * Moves a Scene up one position in the Scenes list.
      *
      * @method Phaser.Scenes.ScenePlugin#moveUp
      * @since 3.0.0
      *
-     * @param {string} key - [description]
+     * @param {string} key - The Scene to move.
      *
      * @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.
      */
@@ -490,12 +495,12 @@ var ScenePlugin = new Class({
     },
 
     /**
-     * [description]
+     * Moves a Scene down one position in the Scenes list.
      *
      * @method Phaser.Scenes.ScenePlugin#moveDown
      * @since 3.0.0
      *
-     * @param {string} key - [description]
+     * @param {string} key - The Scene to move.
      *
      * @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.
      */
@@ -509,12 +514,14 @@ var ScenePlugin = new Class({
     },
 
     /**
-     * [description]
+     * Brings a Scene to the top of the Scenes list.
+     *
+     * This means it will render above all other Scenes.
      *
      * @method Phaser.Scenes.ScenePlugin#bringToTop
      * @since 3.0.0
      *
-     * @param {string} key - [description]
+     * @param {string} key - The Scene to move.
      *
      * @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.
      */
@@ -528,12 +535,14 @@ var ScenePlugin = new Class({
     },
 
     /**
-     * [description]
+     * Sends a Scene to the back of the Scenes list.
+     *
+     * This means it will render below all other Scenes.
      *
      * @method Phaser.Scenes.ScenePlugin#sendToBack
      * @since 3.0.0
      *
-     * @param {string} key - [description]
+     * @param {string} key - The Scene to move.
      *
      * @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.
      */
@@ -547,22 +556,22 @@ var ScenePlugin = new Class({
     },
 
     /**
-     * [description]
+     * Retrieve a Scene.
      *
      * @method Phaser.Scenes.ScenePlugin#get
      * @since 3.0.0
      *
-     * @param {string} key - [description]
+     * @param {string} key - The Scene to retrieve.
      *
-     * @return {Phaser.Scene} [description]
+     * @return {Phaser.Scene} The Scene.
      */
     get: function (key)
     {
         return this.manager.getScene(key);
     },
 
     /**
-     * [description]
+     * Shut down the given Scene.
      *
      * @method Phaser.Scenes.ScenePlugin#shutdown
      * @since 3.0.0
@@ -573,7 +582,7 @@ var ScenePlugin = new Class({
     },
 
     /**
-     * [description]
+     * Destroy the given Scene.
      *
      * @method Phaser.Scenes.ScenePlugin#destroy
      * @since 3.0.0

Original file line number	Diff line number	Diff line change
`@@ -890,7 +890,7 @@ var SceneManager = new Class({`
`890`	`890`	`* @method Phaser.Scenes.SceneManager#sleep`
`891`	`891`	`* @since 3.0.0`
`892`	`892`	`*`
`893`		`- * @param {string} key - The Scene to sleep.`
	`893`	`+ * @param {string} key - The Scene to put to sleep.`
`894`	`894`	`*`
`895`	`895`	`* @return {Phaser.Scenes.SceneManager} This SceneManager.`
`896`	`896`	`*/`
`@@ -935,7 +935,7 @@ var SceneManager = new Class({`
`935`	`935`	`* @since 3.0.0`
`936`	`936`	`*`
`937`	`937`	`* @param {string} key - The Scene to start.`
`938`		`- * @param {object} [data] - Scene config data.`
	`938`	`+ * @param {object} [data] - The Scene data.`
`939`	`939`	`*`
`940`	`940`	`* @return {Phaser.Scenes.SceneManager} This SceneManager.`
`941`	`941`	`*/`
`@@ -1091,7 +1091,7 @@ var SceneManager = new Class({`
`1091`	`1091`	`* @method Phaser.Scenes.SceneManager#bringToTop`
`1092`	`1092`	`* @since 3.0.0`
`1093`	`1093`	`*`
`1094`		`- * @param {(string\|Phaser.Scene)} key - The Scene to affect.`
	`1094`	`+ * @param {(string\|Phaser.Scene)} key - The Scene to move.`
`1095`	`1095`	`*`
`1096`	`1096`	`* @return {Phaser.Scenes.SceneManager} This SceneManager.`
`1097`	`1097`	`*/`
`@@ -1125,7 +1125,7 @@ var SceneManager = new Class({`
`1125`	`1125`	`* @method Phaser.Scenes.SceneManager#sendToBack`
`1126`	`1126`	`* @since 3.0.0`
`1127`	`1127`	`*`
`1128`		`- * @param {(string\|Phaser.Scene)} key - The Scene to affect.`
	`1128`	`+ * @param {(string\|Phaser.Scene)} key - The Scene to move.`
`1129`	`1129`	`*`
`1130`	`1130`	`* @return {Phaser.Scenes.SceneManager} This SceneManager.`
`1131`	`1131`	`*/`
`@@ -1157,7 +1157,7 @@ var SceneManager = new Class({`
`1157`	`1157`	`* @method Phaser.Scenes.SceneManager#moveDown`
`1158`	`1158`	`* @since 3.0.0`
`1159`	`1159`	`*`
`1160`		`- * @param {(string\|Phaser.Scene)} key - The Scene to affect.`
	`1160`	`+ * @param {(string\|Phaser.Scene)} key - The Scene to move.`
`1161`	`1161`	`*`
`1162`	`1162`	`* @return {Phaser.Scenes.SceneManager} This SceneManager.`
`1163`	`1163`	`*/`
`@@ -1191,7 +1191,7 @@ var SceneManager = new Class({`
`1191`	`1191`	`* @method Phaser.Scenes.SceneManager#moveUp`
`1192`	`1192`	`* @since 3.0.0`
`1193`	`1193`	`*`
`1194`		`- * @param {(string\|Phaser.Scene)} key - The Scene to affect.`
	`1194`	`+ * @param {(string\|Phaser.Scene)} key - The Scene to move.`
`1195`	`1195`	`*`
`1196`	`1196`	`* @return {Phaser.Scenes.SceneManager} This SceneManager.`
`1197`	`1197`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ var PluginManager = require('../boot/PluginManager');`
`17`	`17`	`* @constructor`
`18`	`18`	`* @since 3.0.0`
`19`	`19`	`*`
`20`		`- * @param {Phaser.Scene} scene - [description]`
	`20`	`+ * @param {Phaser.Scene} scene - The Scene that this ScenePlugin belongs to.`
`21`	`21`	`*/`
`22`	`22`	`var ScenePlugin = new Class({`
`23`	`23`
`@@ -26,7 +26,7 @@ var ScenePlugin = new Class({`
`26`	`26`	`function ScenePlugin (scene)`
`27`	`27`	`{`
`28`	`28`	`/**`
`29`		`- * [description]`
	`29`	`+ * The Scene that this ScenePlugin belongs to.`
`30`	`30`	`*`
`31`	`31`	`* @name Phaser.Scenes.ScenePlugin#scene`
`32`	`32`	`* @type {Phaser.Scene}`
`@@ -35,7 +35,7 @@ var ScenePlugin = new Class({`
`35`	`35`	`this.scene = scene;`
`36`	`36`
`37`	`37`	`/**`
`38`		`- * [description]`
	`38`	`+ * The Scene Systems instance of the Scene that this ScenePlugin belongs to.`
`39`	`39`	`*`
`40`	`40`	`* @name Phaser.Scenes.ScenePlugin#systems`
`41`	`41`	`* @type {Phaser.Scenes.Systems}`
`@@ -49,7 +49,7 @@ var ScenePlugin = new Class({`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`/**`
`52`		`- * [description]`
	`52`	`+ * The settings of the Scene this ScenePlugin belongs to.`
`53`	`53`	`*`
`54`	`54`	`* @name Phaser.Scenes.ScenePlugin#settings`
`55`	`55`	`* @type {SettingsObject}`
`@@ -58,7 +58,7 @@ var ScenePlugin = new Class({`
`58`	`58`	`this.settings = scene.sys.settings;`
`59`	`59`
`60`	`60`	`/**`
`61`		`- * [description]`
	`61`	`+ * The key of the Scene this ScenePlugin belongs to.`
`62`	`62`	`*`
`63`	`63`	`* @name Phaser.Scenes.ScenePlugin#key`
`64`	`64`	`* @type {string}`
`@@ -67,7 +67,7 @@ var ScenePlugin = new Class({`
`67`	`67`	`this.key = scene.sys.settings.key;`
`68`	`68`
`69`	`69`	`/**`
`70`		`- * [description]`
	`70`	`+ * The Game's SceneManager.`
`71`	`71`	`*`
`72`	`72`	`* @name Phaser.Scenes.ScenePlugin#manager`
`73`	`73`	`* @type {Phaser.Scenes.SceneManager}`
`@@ -77,7 +77,9 @@ var ScenePlugin = new Class({`
`77`	`77`	`},`
`78`	`78`
`79`	`79`	`/**`
`80`		`- * [description]`
	`80`	`+ * Boot the ScenePlugin.`
	`81`	`+ *`
	`82`	`+ * Registers event handlers.`
`81`	`83`	`*`
`82`	`84`	`* @method Phaser.Scenes.ScenePlugin#boot`
`83`	`85`	`* @since 3.0.0`
`@@ -96,8 +98,8 @@ var ScenePlugin = new Class({`
`96`	`98`	`* @method Phaser.Scenes.ScenePlugin#start`
`97`	`99`	`* @since 3.0.0`
`98`	`100`	`*`
`99`		`- * @param {string} key - [description]`
`100`		`- * @param {object} [data] - [description]`
	`101`	`+ * @param {string} key - The Scene to start.`
	`102`	`+ * @param {object} [data] - The Scene data.`
`101`	`103`	`*`
`102`	`104`	`* @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.`
`103`	`105`	`*/`
`@@ -125,9 +127,9 @@ var ScenePlugin = new Class({`
`125`	`127`	`* @method Phaser.Scenes.ScenePlugin#add`
`126`	`128`	`* @since 3.0.0`
`127`	`129`	`*`
`128`		`- * @param {string} key - [description]`
`129`		`- * @param {object} sceneConfig - [description]`
`130`		`- * @param {boolean} autoStart - [description]`
	`130`	`+ * @param {string} key - The Scene key.`
	`131`	`+ * @param {(Phaser.Scene\|SettingsConfig\|function)} sceneConfig - The config for the Scene.`
	`132`	`+ * @param {boolean} autoStart - Whether to start the Scene after it's added.`
`131`	`133`	`*`
`132`	`134`	`* @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.`
`133`	`135`	`*/`
`@@ -144,8 +146,8 @@ var ScenePlugin = new Class({`
`144`	`146`	`* @method Phaser.Scenes.ScenePlugin#launch`
`145`	`147`	`* @since 3.0.0`
`146`	`148`	`*`
`147`		`- * @param {string} key - [description]`
`148`		`- * @param {object} [data] - [description]`
	`149`	`+ * @param {string} key - The Scene to launch.`
	`150`	`+ * @param {object} [data] - The Scene data.`
`149`	`151`	`*`
`150`	`152`	`* @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.`
`151`	`153`	`*/`
`@@ -172,7 +174,7 @@ var ScenePlugin = new Class({`
`172`	`174`	`* @method Phaser.Scenes.ScenePlugin#pause`
`173`	`175`	`* @since 3.0.0`
`174`	`176`	`*`
`175`		`- * @param {string} key - [description]`
	`177`	`+ * @param {string} key - The Scene to pause.`
`176`	`178`	`*`
`177`	`179`	`* @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.`
`178`	`180`	`*/`
`@@ -191,7 +193,7 @@ var ScenePlugin = new Class({`
`191`	`193`	`* @method Phaser.Scenes.ScenePlugin#resume`
`192`	`194`	`* @since 3.0.0`
`193`	`195`	`*`
`194`		`- * @param {string} key - [description]`
	`196`	`+ * @param {string} key - The Scene to resume.`
`195`	`197`	`*`
`196`	`198`	`* @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.`
`197`	`199`	`*/`
`@@ -210,7 +212,7 @@ var ScenePlugin = new Class({`
`210`	`212`	`* @method Phaser.Scenes.ScenePlugin#sleep`
`211`	`213`	`* @since 3.0.0`
`212`	`214`	`*`
`213`		`- * @param {string} key - [description]`
	`215`	`+ * @param {string} key - The Scene to put to sleep.`
`214`	`216`	`*`
`215`	`217`	`* @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.`
`216`	`218`	`*/`
`@@ -229,7 +231,7 @@ var ScenePlugin = new Class({`
`229`	`231`	`* @method Phaser.Scenes.ScenePlugin#wake`
`230`	`232`	`* @since 3.0.0`
`231`	`233`	`*`
`232`		`- * @param {string} key - [description]`
	`234`	`+ * @param {string} key - The Scene to wake up.`
`233`	`235`	`*`
`234`	`236`	`* @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.`
`235`	`237`	`*/`
`@@ -248,7 +250,7 @@ var ScenePlugin = new Class({`
`248`	`250`	`* @method Phaser.Scenes.ScenePlugin#switch`
`249`	`251`	`* @since 3.0.0`
`250`	`252`	`*`
`251`		`- * @param {string} key - [description]`
	`253`	`+ * @param {string} key - The Scene to start.`
`252`	`254`	`*`
`253`	`255`	`* @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.`
`254`	`256`	`*/`
`@@ -275,7 +277,7 @@ var ScenePlugin = new Class({`
`275`	`277`	`* @method Phaser.Scenes.ScenePlugin#stop`
`276`	`278`	`* @since 3.0.0`
`277`	`279`	`*`
`278`		`- * @param {string} key - [description]`
	`280`	`+ * @param {string} key - The Scene to stop.`
`279`	`281`	`*`
`280`	`282`	`* @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.`
`281`	`283`	`*/`
`@@ -294,7 +296,7 @@ var ScenePlugin = new Class({`
`294`	`296`	`* @method Phaser.Scenes.ScenePlugin#setActive`
`295`	`297`	`* @since 3.0.0`
`296`	`298`	`*`
`297`		`- * @param {boolean} value - [description]`
	`299`	`+ * @param {boolean} value - The Scene to set the active state for.`
`298`	`300`	`*`
`299`	`301`	`* @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.`
`300`	`302`	`*/`
`@@ -311,7 +313,7 @@ var ScenePlugin = new Class({`
`311`	`313`	`* @method Phaser.Scenes.ScenePlugin#setVisible`
`312`	`314`	`* @since 3.0.0`
`313`	`315`	`*`
`314`		`- * @param {boolean} value - [description]`
	`316`	`+ * @param {boolean} value - The Scene to set the visible state for.`
`315`	`317`	`*`
`316`	`318`	`* @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.`
`317`	`319`	`*/`
`@@ -328,9 +330,9 @@ var ScenePlugin = new Class({`
`328`	`330`	`* @method Phaser.Scenes.ScenePlugin#isSleeping`
`329`	`331`	`* @since 3.0.0`
`330`	`332`	`*`
`331`		`- * @param {string} key - [description]`
	`333`	`+ * @param {string} key - The Scene to check.`
`332`	`334`	`*`
`333`		`- * @return {boolean} [description]`
	`335`	`+ * @return {boolean} Whether the Scene is sleeping.`
`334`	`336`	`*/`
`335`	`337`	`isSleeping: function (key)`
`336`	`338`	`{`
`@@ -345,9 +347,9 @@ var ScenePlugin = new Class({`
`345`	`347`	`* @method Phaser.Scenes.ScenePlugin#isActive`
`346`	`348`	`* @since 3.0.0`
`347`	`349`	`*`
`348`		`- * @param {string} key - [description]`
	`350`	`+ * @param {string} key - The Scene to check.`
`349`	`351`	`*`
`350`		`- * @return {boolean} [description]`
	`352`	`+ * @return {boolean} Whether the Scene is active.`
`351`	`353`	`*/`
`352`	`354`	`isActive: function (key)`
`353`	`355`	`{`
`@@ -362,9 +364,9 @@ var ScenePlugin = new Class({`
`362`	`364`	`* @method Phaser.Scenes.ScenePlugin#isVisible`
`363`	`365`	`* @since 3.0.0`
`364`	`366`	`*`
`365`		`- * @param {string} key - [description]`
	`367`	`+ * @param {string} key - The Scene to check.`
`366`	`368`	`*`
`367`		`- * @return {boolean} [description]`
	`369`	`+ * @return {boolean} Whether the Scene is visible.`
`368`	`370`	`*/`
`369`	`371`	`isVisible: function (key)`
`370`	`372`	`{`
`@@ -375,6 +377,7 @@ var ScenePlugin = new Class({`
`375`	`377`
`376`	`378`	`/**`
`377`	`379`	`* Swaps the position of two scenes in the Scenes list.`
	`380`	`+ *`
`378`	`381`	`* This controls the order in which they are rendered and updated.`
`379`	`382`	`*`
`380`	`383`	`* @method Phaser.Scenes.ScenePlugin#swapPosition`
`@@ -399,6 +402,7 @@ var ScenePlugin = new Class({`
`399`	`402`
`400`	`403`	`/**`
`401`	`404`	`* Swaps the position of two scenes in the Scenes list, so that Scene B is directly above Scene A.`
	`405`	`+ *`
`402`	`406`	`* This controls the order in which they are rendered and updated.`
`403`	`407`	`*`
`404`	`408`	`* @method Phaser.Scenes.ScenePlugin#moveAbove`
`@@ -423,6 +427,7 @@ var ScenePlugin = new Class({`
`423`	`427`
`424`	`428`	`/**`
`425`	`429`	`* Swaps the position of two scenes in the Scenes list, so that Scene B is directly below Scene A.`
	`430`	`+ *`
`426`	`431`	`* This controls the order in which they are rendered and updated.`
`427`	`432`	`*`
`428`	`433`	`* @method Phaser.Scenes.ScenePlugin#moveBelow`
`@@ -457,7 +462,7 @@ var ScenePlugin = new Class({`
`457`	`462`	`* @method Phaser.Scenes.ScenePlugin#remove`
`458`	`463`	`* @since 3.2.0`
`459`	`464`	`*`
`460`		`- * @param {(string\|Phaser.Scene)} scene - The Scene to be removed.`
	`465`	`+ * @param {(string\|Phaser.Scene)} key - The Scene to be removed.`
`461`	`466`	`*`
`462`	`467`	`* @return {Phaser.Scenes.SceneManager} This SceneManager.`
`463`	`468`	`*/`
`@@ -471,12 +476,12 @@ var ScenePlugin = new Class({`
`471`	`476`	`},`
`472`	`477`
`473`	`478`	`/**`
`474`		`- * [description]`
	`479`	`+ * Moves a Scene up one position in the Scenes list.`
`475`	`480`	`*`
`476`	`481`	`* @method Phaser.Scenes.ScenePlugin#moveUp`
`477`	`482`	`* @since 3.0.0`
`478`	`483`	`*`
`479`		`- * @param {string} key - [description]`
	`484`	`+ * @param {string} key - The Scene to move.`
`480`	`485`	`*`
`481`	`486`	`* @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.`
`482`	`487`	`*/`
`@@ -490,12 +495,12 @@ var ScenePlugin = new Class({`
`490`	`495`	`},`
`491`	`496`
`492`	`497`	`/**`
`493`		`- * [description]`
	`498`	`+ * Moves a Scene down one position in the Scenes list.`
`494`	`499`	`*`
`495`	`500`	`* @method Phaser.Scenes.ScenePlugin#moveDown`
`496`	`501`	`* @since 3.0.0`
`497`	`502`	`*`
`498`		`- * @param {string} key - [description]`
	`503`	`+ * @param {string} key - The Scene to move.`
`499`	`504`	`*`
`500`	`505`	`* @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.`
`501`	`506`	`*/`
`@@ -509,12 +514,14 @@ var ScenePlugin = new Class({`
`509`	`514`	`},`
`510`	`515`
`511`	`516`	`/**`
`512`		`- * [description]`
	`517`	`+ * Brings a Scene to the top of the Scenes list.`
	`518`	`+ *`
	`519`	`+ * This means it will render above all other Scenes.`
`513`	`520`	`*`
`514`	`521`	`* @method Phaser.Scenes.ScenePlugin#bringToTop`
`515`	`522`	`* @since 3.0.0`
`516`	`523`	`*`
`517`		`- * @param {string} key - [description]`
	`524`	`+ * @param {string} key - The Scene to move.`
`518`	`525`	`*`
`519`	`526`	`* @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.`
`520`	`527`	`*/`
`@@ -528,12 +535,14 @@ var ScenePlugin = new Class({`
`528`	`535`	`},`
`529`	`536`
`530`	`537`	`/**`
`531`		`- * [description]`
	`538`	`+ * Sends a Scene to the back of the Scenes list.`
	`539`	`+ *`
	`540`	`+ * This means it will render below all other Scenes.`
`532`	`541`	`*`
`533`	`542`	`* @method Phaser.Scenes.ScenePlugin#sendToBack`
`534`	`543`	`* @since 3.0.0`
`535`	`544`	`*`
`536`		`- * @param {string} key - [description]`
	`545`	`+ * @param {string} key - The Scene to move.`
`537`	`546`	`*`
`538`	`547`	`* @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.`
`539`	`548`	`*/`
`@@ -547,22 +556,22 @@ var ScenePlugin = new Class({`
`547`	`556`	`},`
`548`	`557`
`549`	`558`	`/**`
`550`		`- * [description]`
	`559`	`+ * Retrieve a Scene.`
`551`	`560`	`*`
`552`	`561`	`* @method Phaser.Scenes.ScenePlugin#get`
`553`	`562`	`* @since 3.0.0`
`554`	`563`	`*`
`555`		`- * @param {string} key - [description]`
	`564`	`+ * @param {string} key - The Scene to retrieve.`
`556`	`565`	`*`
`557`		`- * @return {Phaser.Scene} [description]`
	`566`	`+ * @return {Phaser.Scene} The Scene.`
`558`	`567`	`*/`
`559`	`568`	`get: function (key)`
`560`	`569`	`{`
`561`	`570`	`return this.manager.getScene(key);`
`562`	`571`	`},`
`563`	`572`
`564`	`573`	`/**`
`565`		`- * [description]`
	`574`	`+ * Shut down the given Scene.`
`566`	`575`	`*`
`567`	`576`	`* @method Phaser.Scenes.ScenePlugin#shutdown`
`568`	`577`	`* @since 3.0.0`
`@@ -573,7 +582,7 @@ var ScenePlugin = new Class({`
`573`	`582`	`},`
`574`	`583`
`575`	`584`	`/**`
`576`		`- * [description]`
	`585`	`+ * Destroy the given Scene.`
`577`	`586`	`*`
`578`	`587`	`* @method Phaser.Scenes.ScenePlugin#destroy`
`579`	`588`	`* @since 3.0.0`