Skip to content

Commit 29089a3

Browse files
photonstormphotonstorm
committed
Merge branch 'master' of https://github.com/photonstorm/phaser 
2 parents 0b7c259 + b5deafa commit 29089a3

6 files changed

Lines changed: 60 additions & 25 deletions

File tree

‎src/gameobjects/DisplayList.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ var StableSort = require('../utils/array/StableSort');
1414
* [description]
1515
*
1616
* @class DisplayList
17-
* @extends Phaser.Structs.List
17+
* @extends Phaser.Structs.List.<Phaser.GameObjects.GameObject>
1818
* @memberOf Phaser.GameObjects
1919
* @constructor
2020
* @since 3.0.0

‎src/gameobjects/components/ToJSON.js‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66

77
/**
88
* @typedef {object} JSONGameObject
9-
* @generic {object} DATA - [data]
109
*
1110
* @property {string} name - The name of this Game Object.
1211
* @property {string} type - A textual representation of this Game Object, i.e. `sprite`.

‎src/structs/List.js‎

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ var Class = require('../utils/Class');
88

99
/**
1010
* @callback EachListCallback
11-
* @generic {*} I - [item]
11+
* @generic I - [item]
1212
*
1313
* @param {*} item - [description]
1414
* @param {...*} [args] - Additional arguments that will be passed to the callback, after the child.
@@ -18,8 +18,6 @@ var Class = require('../utils/Class');
1818
* @classdesc
1919
* [description]
2020
*
21-
* @generic T
22-
*
2321
* @class List
2422
* @memberOf Phaser.Structs
2523
* @constructor
@@ -245,7 +243,7 @@ var List = new Class({
245243
* @since 3.0.0
246244
*
247245
* @genericUse {T} - [value]
248-
* @genericUse {?T} - [$return]
246+
* @genericUse {T | null} - [$return]
249247
*
250248
* @param {string} property - The property to check against the value.
251249
* @param {*} value - The value to check if the property strictly equals.
@@ -273,7 +271,7 @@ var List = new Class({
273271
* @method Phaser.Structs.List#getByName
274272
* @since 3.0.0
275273
*
276-
* @genericUse {?T} - [$return]
274+
* @genericUse {T | null} - [$return]
277275
*
278276
* @param {string} name - The name to search for.
279277
*
@@ -290,7 +288,7 @@ var List = new Class({
290288
* @method Phaser.Structs.List#getRandom
291289
* @since 3.0.0
292290
*
293-
* @genericUse {?T} - [$return]
291+
* @genericUse {T | null} - [$return]
294292
*
295293
* @param {integer} [startIndex=0] - Offset from the front of the group (lowest child).
296294
* @param {integer} [length=(to top)] - Restriction on the number of values you want to randomly select from.
@@ -319,7 +317,7 @@ var List = new Class({
319317
* @since 3.0.0
320318
*
321319
* @genericUse {T} - [value]
322-
* @genericUse {?T} - [$return]
320+
* @genericUse {T | null} - [$return]
323321
*
324322
* @param {string} property - [description]
325323
* @param {*} value - [description]
@@ -578,6 +576,8 @@ var List = new Class({
578576
* @method Phaser.Structs.List#removeAll
579577
* @since 3.0.0
580578
*
579+
* @genericUse {Phaser.Structs.List.<T>} - [$return]
580+
*
581581
* @return {Phaser.Structs.List} This List object.
582582
*/
583583
removeAll: function ()
@@ -598,7 +598,7 @@ var List = new Class({
598598
* @method Phaser.Structs.List#bringToTop
599599
* @since 3.0.0
600600
*
601-
* @generic {T} O - [child,$return]
601+
* @genericUse {T} - [child,$return]
602602
*
603603
* @param {*} child - [description]
604604
*
@@ -621,7 +621,7 @@ var List = new Class({
621621
* @method Phaser.Structs.List#sendToBack
622622
* @since 3.0.0
623623
*
624-
* @generic {T} O - [child,$return]
624+
* @genericUse {T} - [child,$return]
625625
*
626626
* @param {*} child - [description]
627627
*
@@ -644,7 +644,7 @@ var List = new Class({
644644
* @method Phaser.Structs.List#moveUp
645645
* @since 3.0.0
646646
*
647-
* @generic {T} O - [child,$return]
647+
* @genericUse {T} - [child,$return]
648648
*
649649
* @param {*} child - [description]
650650
*
@@ -673,7 +673,7 @@ var List = new Class({
673673
* @method Phaser.Structs.List#moveDown
674674
* @since 3.0.0
675675
*
676-
* @generic {T} O - [child,$return]
676+
* @genericUse {T} - [child,$return]
677677
*
678678
* @param {*} child - [description]
679679
*
@@ -702,6 +702,8 @@ var List = new Class({
702702
* @method Phaser.Structs.List#reverse
703703
* @since 3.0.0
704704
*
705+
* @genericUse {Phaser.Structs.List.<T>} - [$return]
706+
*
705707
* @return {Phaser.Structs.List} This List object.
706708
*/
707709
reverse: function ()
@@ -717,6 +719,8 @@ var List = new Class({
717719
* @method Phaser.Structs.List#shuffle
718720
* @since 3.0.0
719721
*
722+
* @genericUse {Phaser.Structs.List.<T>} - [$return]
723+
*
720724
* @return {Phaser.Structs.List} This List object.
721725
*/
722726
shuffle: function ()
@@ -738,7 +742,7 @@ var List = new Class({
738742
* @method Phaser.Structs.List#replace
739743
* @since 3.0.0
740744
*
741-
* @generic {T} O - [oldChild,newChild,$return]
745+
* @genericUse {T} - [oldChild,newChild,$return]
742746
*
743747
* @param {*} oldChild - The child in this List that will be replaced.
744748
* @param {*} newChild - The child to be inserted into this List.

‎src/structs/Map.js‎

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ var Class = require('../utils/Class');
88

99
/**
1010
* @callback EachMapCallback
11-
* @generic {*} E - [entry]
11+
* @generic E - [entry]
1212
*
1313
* @param {string} key - [description]
1414
* @param {E} entry - [description]
@@ -30,8 +30,9 @@ var Class = require('../utils/Class');
3030
* @constructor
3131
* @since 3.0.0
3232
*
33-
* @generic T
34-
* @genericUse {T[]} - [elements]
33+
* @generic K
34+
* @generic V
35+
* @genericUse {V[]} - [elements]
3536
*
3637
* @param {Array.<*>} elements - [description]
3738
*/
@@ -44,7 +45,7 @@ var Map = new Class({
4445
/**
4546
* [description]
4647
*
47-
* @genericUse {Object.<string, T>} - [$type]
48+
* @genericUse {Object.<string, V>} - [$type]
4849
*
4950
* @name Phaser.Structs.Map#entries
5051
* @type {Object.<string, *>}
@@ -78,7 +79,9 @@ var Map = new Class({
7879
* @method Phaser.Structs.Map#set
7980
* @since 3.0.0
8081
*
81-
* @genericUse {T} - [value]
82+
* @genericUse {K} - [key]
83+
* @genericUse {V} - [value]
84+
* @genericUse {Phaser.Structs.Map.<K, V>} - [$return]
8285
*
8386
* @param {string} key - [description]
8487
* @param {*} value - [description]
@@ -102,7 +105,8 @@ var Map = new Class({
102105
* @method Phaser.Structs.Map#get
103106
* @since 3.0.0
104107
*
105-
* @genericUse {T} - [$return]
108+
* @genericUse {K} - [key]
109+
* @genericUse {V} - [$return]
106110
*
107111
* @param {string} key - [description]
108112
*
@@ -122,7 +126,7 @@ var Map = new Class({
122126
* @method Phaser.Structs.Map#getArray
123127
* @since 3.0.0
124128
*
125-
* @genericUse {T[]} - [$return]
129+
* @genericUse {V[]} - [$return]
126130
*
127131
* @return {Array.<*>} [description]
128132
*/
@@ -145,6 +149,8 @@ var Map = new Class({
145149
* @method Phaser.Structs.Map#has
146150
* @since 3.0.0
147151
*
152+
* @genericUse {K} - [key]
153+
*
148154
* @param {string} key - [description]
149155
*
150156
* @return {boolean} [description]
@@ -160,6 +166,9 @@ var Map = new Class({
160166
* @method Phaser.Structs.Map#delete
161167
* @since 3.0.0
162168
*
169+
* @genericUse {K} - [key]
170+
* @genericUse {Phaser.Structs.Map.<K, V>} - [$return]
171+
*
163172
* @param {string} key - [description]
164173
*
165174
* @return {Phaser.Structs.Map} This Map object.
@@ -181,6 +190,8 @@ var Map = new Class({
181190
* @method Phaser.Structs.Map#clear
182191
* @since 3.0.0
183192
*
193+
* @genericUse {Phaser.Structs.Map.<K, V>} - [$return]
194+
*
184195
* @return {Phaser.Structs.Map} This Map object.
185196
*/
186197
clear: function ()
@@ -202,6 +213,8 @@ var Map = new Class({
202213
* @method Phaser.Structs.Map#keys
203214
* @since 3.0.0
204215
*
216+
* @genericUse {K[]} - [$return]
217+
*
205218
* @return {string[]} [description]
206219
*/
207220
keys: function ()
@@ -215,7 +228,7 @@ var Map = new Class({
215228
* @method Phaser.Structs.Map#values
216229
* @since 3.0.0
217230
*
218-
* @genericUse {T[]} - [$return]
231+
* @genericUse {V[]} - [$return]
219232
*
220233
* @return {Array.<*>} [description]
221234
*/
@@ -260,7 +273,8 @@ var Map = new Class({
260273
* @method Phaser.Structs.Map#each
261274
* @since 3.0.0
262275
*
263-
* @genericUse {EachMapCallback.<T>} - [callback]
276+
* @genericUse {EachMapCallback.<V>} - [callback]
277+
* @genericUse {Phaser.Structs.Map.<K, V>} - [$return]
264278
*
265279
* @param {EachMapCallback} callback - [description]
266280
*
@@ -287,7 +301,7 @@ var Map = new Class({
287301
* @method Phaser.Structs.Map#contains
288302
* @since 3.0.0
289303
*
290-
* @genericUse {T} - [value]
304+
* @genericUse {V} - [value]
291305
*
292306
* @param {*} value - [description]
293307
*
@@ -316,6 +330,8 @@ var Map = new Class({
316330
* @method Phaser.Structs.Map#merge
317331
* @since 3.0.0
318332
*
333+
* @genericUse {Phaser.Structs.Map.<K, V>} - [map,$return]
334+
*
319335
* @param {Phaser.Structs.Map} map - [description]
320336
* @param {boolean} [override=false] - [description]
321337
*

‎src/structs/ProcessQueue.js‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ var ProcessQueue = new Class({
8181
* @since 3.0.0
8282
*
8383
* @genericUse {T} - [item]
84+
* @genericUse {Phaser.Structs.ProcessQueue.<T>} - [$return]
8485
*
8586
* @param {*} item - [description]
8687
*
@@ -102,6 +103,7 @@ var ProcessQueue = new Class({
102103
* @since 3.0.0
103104
*
104105
* @genericUse {T} - [item]
106+
* @genericUse {Phaser.Structs.ProcessQueue.<T>} - [$return]
105107
*
106108
* @param {*} item - [description]
107109
*

‎src/structs/Set.js‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ var Class = require('../utils/Class');
88

99
/**
1010
* @callback EachSetCallback
11-
* @generic {*} E - [entry]
11+
* @generic E - [entry]
1212
*
1313
* @param {*} entry - [description]
1414
* @param {number} index - [description]
@@ -64,6 +64,7 @@ var Set = new Class({
6464
* @since 3.0.0
6565
*
6666
* @genericUse {T} - [value]
67+
* @genericUse {Phaser.Structs.Set.<T>} - [$return]
6768
*
6869
* @param {*} value - [description]
6970
*
@@ -127,6 +128,7 @@ var Set = new Class({
127128
* @since 3.0.0
128129
*
129130
* @genericUse {T} - [value]
131+
* @genericUse {Phaser.Structs.Set.<T>} - [$return]
130132
*
131133
* @param {*} value - [description]
132134
*
@@ -172,6 +174,7 @@ var Set = new Class({
172174
* @since 3.0.0
173175
*
174176
* @genericUse {EachSetCallback.<T>} - [callback]
177+
* @genericUse {Phaser.Structs.Set.<T>} - [$return]
175178
*
176179
* @param {EachSetCallback} callback - [description]
177180
* @param {*} callbackScope - [description]
@@ -215,6 +218,7 @@ var Set = new Class({
215218
* @since 3.0.0
216219
*
217220
* @genericUse {EachSetCallback.<T>} - [callback]
221+
* @genericUse {Phaser.Structs.Set.<T>} - [$return]
218222
*
219223
* @param {EachSetCallback} callback - [description]
220224
* @param {*} callbackScope - [description]
@@ -256,6 +260,8 @@ var Set = new Class({
256260
* @method Phaser.Structs.Set#iterateLocal
257261
* @since 3.0.0
258262
*
263+
* @genericUse {Phaser.Structs.Set.<T>} - [$return]
264+
*
259265
* @param {string} callbackKey - [description]
260266
* @param {...*} [args] - Additional arguments that will be passed to the callback, after the child.
261267
*
@@ -289,6 +295,8 @@ var Set = new Class({
289295
* @method Phaser.Structs.Set#clear
290296
* @since 3.0.0
291297
*
298+
* @genericUse {Phaser.Structs.Set.<T>} - [$return]
299+
*
292300
* @return {Phaser.Structs.Set} This Set object.
293301
*/
294302
clear: function ()
@@ -321,6 +329,8 @@ var Set = new Class({
321329
* @method Phaser.Structs.Set#union
322330
* @since 3.0.0
323331
*
332+
* @genericUse {Phaser.Structs.Set.<T>} - [set,$return]
333+
*
324334
* @param {Phaser.Structs.Set} set - [description]
325335
*
326336
* @return {Phaser.Structs.Set} [description]
@@ -348,6 +358,8 @@ var Set = new Class({
348358
* @method Phaser.Structs.Set#intersect
349359
* @since 3.0.0
350360
*
361+
* @genericUse {Phaser.Structs.Set.<T>} - [set,$return]
362+
*
351363
* @param {Phaser.Structs.Set} set - [description]
352364
*
353365
* @return {Phaser.Structs.Set} [description]
@@ -373,6 +385,8 @@ var Set = new Class({
373385
* @method Phaser.Structs.Set#difference
374386
* @since 3.0.0
375387
*
388+
* @genericUse {Phaser.Structs.Set.<T>} - [set,$return]
389+
*
376390
* @param {Phaser.Structs.Set} set - [description]
377391
*
378392
* @return {Phaser.Structs.Set} [description]

0 commit comments

Comments
 (0)