Skip to content

Commit 206d612

Browse files
committed
Mark optional params as optional in jsdoc
1 parent d7860e6 commit 206d612

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

src/scene/ScenePlugin.js

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -608,7 +608,7 @@ var ScenePlugin = new Class({
608608
* @method Phaser.Scenes.ScenePlugin#stop
609609
* @since 3.0.0
610610
*
611-
* @param {string} key - The Scene to stop.
611+
* @param {string} [key] - The Scene to stop.
612612
*
613613
* @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.
614614
*/
@@ -678,7 +678,7 @@ var ScenePlugin = new Class({
678678
* @method Phaser.Scenes.ScenePlugin#isSleeping
679679
* @since 3.0.0
680680
*
681-
* @param {string} key - The Scene to check.
681+
* @param {string} [key] - The Scene to check.
682682
*
683683
* @return {boolean} Whether the Scene is sleeping.
684684
*/
@@ -695,7 +695,7 @@ var ScenePlugin = new Class({
695695
* @method Phaser.Scenes.ScenePlugin#isActive
696696
* @since 3.0.0
697697
*
698-
* @param {string} key - The Scene to check.
698+
* @param {string} [key] - The Scene to check.
699699
*
700700
* @return {boolean} Whether the Scene is active.
701701
*/
@@ -712,7 +712,7 @@ var ScenePlugin = new Class({
712712
* @method Phaser.Scenes.ScenePlugin#isVisible
713713
* @since 3.0.0
714714
*
715-
* @param {string} key - The Scene to check.
715+
* @param {string} [key] - The Scene to check.
716716
*
717717
* @return {boolean} Whether the Scene is visible.
718718
*/
@@ -810,7 +810,7 @@ var ScenePlugin = new Class({
810810
* @method Phaser.Scenes.ScenePlugin#remove
811811
* @since 3.2.0
812812
*
813-
* @param {(string|Phaser.Scene)} key - The Scene to be removed.
813+
* @param {(string|Phaser.Scene)} [key] - The Scene to be removed.
814814
*
815815
* @return {Phaser.Scenes.SceneManager} This SceneManager.
816816
*/
@@ -829,7 +829,7 @@ var ScenePlugin = new Class({
829829
* @method Phaser.Scenes.ScenePlugin#moveUp
830830
* @since 3.0.0
831831
*
832-
* @param {string} key - The Scene to move.
832+
* @param {string} [key] - The Scene to move.
833833
*
834834
* @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.
835835
*/
@@ -848,7 +848,7 @@ var ScenePlugin = new Class({
848848
* @method Phaser.Scenes.ScenePlugin#moveDown
849849
* @since 3.0.0
850850
*
851-
* @param {string} key - The Scene to move.
851+
* @param {string} [key] - The Scene to move.
852852
*
853853
* @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.
854854
*/
@@ -869,7 +869,7 @@ var ScenePlugin = new Class({
869869
* @method Phaser.Scenes.ScenePlugin#bringToTop
870870
* @since 3.0.0
871871
*
872-
* @param {string} key - The Scene to move.
872+
* @param {string} [key] - The Scene to move.
873873
*
874874
* @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.
875875
*/
@@ -890,7 +890,7 @@ var ScenePlugin = new Class({
890890
* @method Phaser.Scenes.ScenePlugin#sendToBack
891891
* @since 3.0.0
892892
*
893-
* @param {string} key - The Scene to move.
893+
* @param {string} [key] - The Scene to move.
894894
*
895895
* @return {Phaser.Scenes.ScenePlugin} This ScenePlugin object.
896896
*/

0 commit comments

Comments
 (0)