Skip to content

Commit 44103dc

Browse files
committed
Fix remaining multiple types
1 parent 9375bb0 commit 44103dc

15 files changed

Lines changed: 42 additions & 42 deletions

src/loader/File.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ var File = new Class({
164164
* If this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)
165165
*
166166
* @name Phaser.Loader.File#crossOrigin
167-
* @type {string|undefined}
167+
* @type {(string|undefined)}
168168
* @since 3.0.0
169169
*/
170170
this.crossOrigin = undefined;

src/loader/filetypes/AnimationJSONFile.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var AnimationJSONFile = function (key, url, path, xhrSettings)
3232

3333
/**
3434
* Adds an Animation JSON file to the current load queue.
35-
*
35+
*
3636
* Note: This method will only be available if the Animation JSON File type has been built into Phaser.
3737
*
3838
* The file is **not** loaded immediately after calling this method.
@@ -41,11 +41,11 @@ var AnimationJSONFile = function (key, url, path, xhrSettings)
4141
* @method Phaser.Loader.LoaderPlugin#animation
4242
* @since 3.0.0
4343
*
44-
* @param {string|array|object} key - A unique string to be used as the key to reference this file from the Cache. Must be unique within this file type.
44+
* @param {(string|array|object)} key - A unique string to be used as the key to reference this file from the Cache. Must be unique within this file type.
4545
* @param {string} [url] - URL of the file. If `undefined` or `null` the url will be set to `<key>.json`,
4646
* i.e. if `key` was "alien" then the URL will be "alien.json".
4747
* @param {object} [xhrSettings] - File specific XHR settings to be used during the load. These settings are merged with the global Loader XHR settings.
48-
*
48+
*
4949
* @return {Phaser.Loader.LoaderPlugin} The Loader.
5050
*/
5151
FileTypesManager.register('animation', function (key, url, xhrSettings)
@@ -68,9 +68,9 @@ FileTypesManager.register('animation', function (key, url, xhrSettings)
6868
});
6969

7070
// When registering a factory function 'this' refers to the Loader context.
71-
//
71+
//
7272
// There are several properties available to use:
73-
//
73+
//
7474
// this.scene - a reference to the Scene that owns the GameObjectFactory
7575

7676
module.exports = AnimationJSONFile;

src/loader/filetypes/AudioFile.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ AudioFile.create = function (loader, key, urls, config, xhrSettings)
138138
* @since 3.0.0
139139
*
140140
* @param {string} key - [description]
141-
* @param {string|string[]} urls - [description]
141+
* @param {(string|string[])} urls - [description]
142142
* @param {object} config - [description]
143143
* @param {object} xhrSettings - [description]
144144
*

src/loader/filetypes/AudioSprite.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ var JSONFile = require('./JSONFile.js');
1111

1212
/**
1313
* Adds an Audio Sprite file to the current load queue.
14-
*
14+
*
1515
* Note: This method will only be available if the Audio Sprite File type has been built into Phaser.
1616
*
1717
* The file is **not** loaded immediately after calling this method.
@@ -21,12 +21,12 @@ var JSONFile = require('./JSONFile.js');
2121
* @since 3.0.0
2222
*
2323
* @param {string} key - [description]
24-
* @param {string|string[]} urls - [description]
24+
* @param {(string|string[])} urls - [description]
2525
* @param {object} json - [description]
2626
* @param {object} config - [description]
2727
* @param {object} audioXhrSettings - Optional file specific XHR settings.
2828
* @param {object} jsonXhrSettings - Optional file specific XHR settings.
29-
*
29+
*
3030
* @return {Phaser.Loader.LoaderPlugin} The Loader.
3131
*/
3232
FileTypesManager.register('audioSprite', function (key, urls, json, config, audioXhrSettings, jsonXhrSettings)

src/scene/SceneManager.js

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ var SceneManager = new Class({
257257
* @since 3.0.0
258258
*
259259
* @param {string} key - A unique key used to reference the Scene, i.e. `MainMenu` or `Level1`.
260-
* @param {Phaser.Scene|object|function} sceneConfig - [description]
260+
* @param {(Phaser.Scene|object|function)} sceneConfig - [description]
261261
* @param {boolean} [autoStart=false] - If `true` the Scene will be started immediately after being added.
262262
*
263263
* @return {?Phaser.Scene} [description]
@@ -332,7 +332,7 @@ var SceneManager = new Class({
332332
* @method Phaser.Scenes.SceneManager#remove
333333
* @since 3.2.0
334334
*
335-
* @param {string|Phaser.Scene} scene - The Scene to be removed.
335+
* @param {(string|Phaser.Scene)} scene - The Scene to be removed.
336336
*
337337
* @return {Phaser.Scenes.SceneManager} This SceneManager.
338338
*/
@@ -706,7 +706,7 @@ var SceneManager = new Class({
706706
* @since 3.0.0
707707
*
708708
* @param {string} key - [description]
709-
* @param {Phaser.Scene|object|function} sceneConfig - [description]
709+
* @param {(Phaser.Scene|object|function)} sceneConfig - [description]
710710
*
711711
* @return {string} [description]
712712
*/
@@ -1057,7 +1057,7 @@ var SceneManager = new Class({
10571057
*
10581058
* @param {integer} index - [description]
10591059
*
1060-
* @return {Phaser.Scene|undefined} [description]
1060+
* @return {(Phaser.Scene|undefined)} [description]
10611061
*/
10621062
getAt: function (index)
10631063
{
@@ -1070,7 +1070,7 @@ var SceneManager = new Class({
10701070
* @method Phaser.Scenes.SceneManager#getIndex
10711071
* @since 3.0.0
10721072
*
1073-
* @param {string|Phaser.Scene} key - [description]
1073+
* @param {(string|Phaser.Scene)} key - [description]
10741074
*
10751075
* @return {integer} [description]
10761076
*/
@@ -1087,7 +1087,7 @@ var SceneManager = new Class({
10871087
* @method Phaser.Scenes.SceneManager#bringToTop
10881088
* @since 3.0.0
10891089
*
1090-
* @param {string|Phaser.Scene} key - [description]
1090+
* @param {(string|Phaser.Scene)} key - [description]
10911091
*
10921092
* @return {Phaser.Scenes.SceneManager} [description]
10931093
*/
@@ -1119,7 +1119,7 @@ var SceneManager = new Class({
11191119
* @method Phaser.Scenes.SceneManager#sendToBack
11201120
* @since 3.0.0
11211121
*
1122-
* @param {string|Phaser.Scene} key - [description]
1122+
* @param {(string|Phaser.Scene)} key - [description]
11231123
*
11241124
* @return {Phaser.Scenes.SceneManager} [description]
11251125
*/
@@ -1151,7 +1151,7 @@ var SceneManager = new Class({
11511151
* @method Phaser.Scenes.SceneManager#moveDown
11521152
* @since 3.0.0
11531153
*
1154-
* @param {string|Phaser.Scene} key - [description]
1154+
* @param {(string|Phaser.Scene)} key - [description]
11551155
*
11561156
* @return {Phaser.Scenes.SceneManager} [description]
11571157
*/
@@ -1185,7 +1185,7 @@ var SceneManager = new Class({
11851185
* @method Phaser.Scenes.SceneManager#moveUp
11861186
* @since 3.0.0
11871187
*
1188-
* @param {string|Phaser.Scene} key - [description]
1188+
* @param {(string|Phaser.Scene)} key - [description]
11891189
*
11901190
* @return {Phaser.Scenes.SceneManager} [description]
11911191
*/
@@ -1220,8 +1220,8 @@ var SceneManager = new Class({
12201220
* @method Phaser.Scenes.SceneManager#moveAbove
12211221
* @since 3.2.0
12221222
*
1223-
* @param {string|Phaser.Scene} keyA - The Scene that Scene B will be moved above.
1224-
* @param {string|Phaser.Scene} keyB - The Scene to be moved.
1223+
* @param {(string|Phaser.Scene)} keyA - The Scene that Scene B will be moved above.
1224+
* @param {(string|Phaser.Scene)} keyB - The Scene to be moved.
12251225
*
12261226
* @return {Phaser.Scenes.SceneManager} [description]
12271227
*/
@@ -1263,8 +1263,8 @@ var SceneManager = new Class({
12631263
* @method Phaser.Scenes.SceneManager#moveBelow
12641264
* @since 3.2.0
12651265
*
1266-
* @param {string|Phaser.Scene} keyA - The Scene that Scene B will be moved above.
1267-
* @param {string|Phaser.Scene} keyB - The Scene to be moved.
1266+
* @param {(string|Phaser.Scene)} keyA - The Scene that Scene B will be moved above.
1267+
* @param {(string|Phaser.Scene)} keyB - The Scene to be moved.
12681268
*
12691269
* @return {Phaser.Scenes.SceneManager} [description]
12701270
*/
@@ -1312,8 +1312,8 @@ var SceneManager = new Class({
13121312
* @method Phaser.Scenes.SceneManager#swapPosition
13131313
* @since 3.0.0
13141314
*
1315-
* @param {string|Phaser.Scene} keyA - [description]
1316-
* @param {string|Phaser.Scene} keyB - [description]
1315+
* @param {(string|Phaser.Scene)} keyA - [description]
1316+
* @param {(string|Phaser.Scene)} keyB - [description]
13171317
*
13181318
* @return {Phaser.Scenes.SceneManager} [description]
13191319
*/

src/scene/ScenePlugin.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -457,7 +457,7 @@ var ScenePlugin = new Class({
457457
* @method Phaser.Scenes.ScenePlugin#remove
458458
* @since 3.2.0
459459
*
460-
* @param {string|Phaser.Scene} scene - The Scene to be removed.
460+
* @param {(string|Phaser.Scene)} scene - The Scene to be removed.
461461
*
462462
* @return {Phaser.Scenes.SceneManager} This SceneManager.
463463
*/

src/scene/Systems.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ var Systems = new Class({
288288
* @method Phaser.Scenes.Systems#render
289289
* @since 3.0.0
290290
*
291-
* @param {Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer} renderer - [description]
291+
* @param {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)} renderer - [description]
292292
*/
293293
render: function (renderer)
294294
{

src/tweens/TweenManager.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@ var TweenManager = new Class({
446446
* @method Phaser.Tweens.TweenManager#getTweensOf
447447
* @since 3.0.0
448448
*
449-
* @param {object|array} target - [description]
449+
* @param {(object|array)} target - [description]
450450
*
451451
* @return {Phaser.Tweens.Tween[]} [description]
452452
*/
@@ -542,7 +542,7 @@ var TweenManager = new Class({
542542
* @method Phaser.Tweens.TweenManager#killTweensOf
543543
* @since 3.0.0
544544
*
545-
* @param {object|array} target - [description]
545+
* @param {(object|array)} target - [description]
546546
*
547547
* @return {Phaser.Tweens.TweenManager} [description]
548548
*/

src/tweens/builders/GetEaseFunction.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ var EaseMap = require('../../math/easing/EaseMap');
1212
* @function Phaser.Tweens.Builders.GetEaseFunction
1313
* @since 3.0.0
1414
*
15-
* @param {string|function} ease - [description]
15+
* @param {(string|function)} ease - [description]
1616
* @param {array} easeParams - [description]
1717
*
1818
* @return {function} [description]

src/tweens/builders/NumberTweenBuilder.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ var TweenData = require('../tween/TweenData');
2020
* @function Phaser.Tweens.Builders.NumberTweenBuilder
2121
* @since 3.0.0
2222
*
23-
* @param {Phaser.Tweens.TweenManager|Phaser.Tweens.Timeline} parent - [description]
23+
* @param {(Phaser.Tweens.TweenManager|Phaser.Tweens.Timeline)} parent - [description]
2424
* @param {object} config - [description]
2525
* @param {Phaser.Tweens.Tween~ConfigDefaults} defaults - [description]
2626
*
@@ -38,9 +38,9 @@ var NumberTweenBuilder = function (parent, config, defaults)
3838
// to: 200,
3939
// ... (normal tween properties)
4040
// })
41-
//
41+
//
4242
// Then use it in your game via:
43-
//
43+
//
4444
// tween.getValue()
4545

4646
var from = GetValue(config, 'from', 0);

0 commit comments

Comments
 (0)