Skip to content

Commit a3b615b

Browse files
committed
JSDoc fixes
1 parent d04232a commit a3b615b

3 files changed

Lines changed: 26 additions & 28 deletions

File tree

src/animations/AnimationManager.js

Lines changed: 6 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -261,28 +261,16 @@ var AnimationManager = new Class({
261261
return output;
262262
},
263263

264-
/**
265-
* @typedef {object} GenerateFrameNamesConfig
266-
*
267-
* @property {string} [prefix=''] - The string to append to every resulting frame name if using a range or an array of `frames`.
268-
* @property {integer} [start=0] - If `frames` is not provided, the number of the first frame to return.
269-
* @property {integer} [end=0] - If `frames` is not provided, the number of the last frame to return.
270-
* @property {string} [suffix=''] - The string to append to every resulting frame name if using a range or an array of `frames`.
271-
* @property {integer} [zeroPad=0] - The minimum expected lengths of each resulting frame's number. Numbers will be left-padded with zeroes until they are this long, then prepended and appended to create the resulting frame name.
272-
* @property {AnimationFrameConfig[]} [outputArray=[]] - The array to append the created configuration objects to.
273-
* @property {boolean} [frames=false] - If provided as an array, the range defined by `start` and `end` will be ignored and these frame numbers will be used.
274-
*/
275-
276264
/**
277265
* [description]
278266
*
279267
* @method Phaser.Animations.AnimationManager#generateFrameNames
280268
* @since 3.0.0
281269
*
282270
* @param {string} key - The key for the texture containing the animation frames.
283-
* @param {GenerateFrameNamesConfig} [config] - The configuration object for the animation frame names.
271+
* @param {Phaser.Animations.Types.GenerateFrameNames} [config] - The configuration object for the animation frame names.
284272
*
285-
* @return {AnimationFrameConfig[]} The array of {@link AnimationFrameConfig} objects.
273+
* @return {Phaser.Animations.Types.AnimationFrame[]} The array of {@link Phaser.Animations.Types.AnimationFrame} objects.
286274
*/
287275
generateFrameNames: function (key, config)
288276
{
@@ -349,27 +337,17 @@ var AnimationManager = new Class({
349337
},
350338

351339
/**
352-
* @typedef {object} GenerateFrameNumbersConfig
353-
*
354-
* @property {integer} [start=0] - The starting frame of the animation.
355-
* @property {integer} [end=-1] - The ending frame of the animation.
356-
* @property {(boolean|integer)} [first=false] - A frame to put at the beginning of the animation, before `start` or `outputArray` or `frames`.
357-
* @property {AnimationFrameConfig[]} [outputArray=[]] - An array to concatenate the output onto.
358-
* @property {(boolean|integer[])} [frames=false] - A custom sequence of frames.
359-
*/
360-
361-
/**
362-
* Generate an array of {@link AnimationFrameConfig} objects from a texture key and configuration object.
340+
* Generate an array of {@link Phaser.Animations.Types.AnimationFrame} objects from a texture key and configuration object.
363341
*
364-
* Generates objects with numbered frame names, as configured by the given {@link GenerateFrameNumbersConfig}.
342+
* Generates objects with numbered frame names, as configured by the given {@link Phaser.Animations.Types.GenerateFrameNumbers}.
365343
*
366344
* @method Phaser.Animations.AnimationManager#generateFrameNumbers
367345
* @since 3.0.0
368346
*
369347
* @param {string} key - The key for the texture containing the animation frames.
370-
* @param {GenerateFrameNumbersConfig} config - The configuration object for the animation frames.
348+
* @param {Phaser.Animations.Types.GenerateFrameNumbers} config - The configuration object for the animation frames.
371349
*
372-
* @return {AnimationFrameConfig[]} The array of {@link AnimationFrameConfig} objects.
350+
* @return {Phaser.Animations.Types.AnimationFrame[]} The array of {@link Phaser.Animations.Types.AnimationFrame} objects.
373351
*/
374352
generateFrameNumbers: function (key, config)
375353
{
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
/**
2+
* @typedef {object} Phaser.Animations.Types.GenerateFrameNames
3+
*
4+
* @property {string} [prefix=''] - The string to append to every resulting frame name if using a range or an array of `frames`.
5+
* @property {integer} [start=0] - If `frames` is not provided, the number of the first frame to return.
6+
* @property {integer} [end=0] - If `frames` is not provided, the number of the last frame to return.
7+
* @property {string} [suffix=''] - The string to append to every resulting frame name if using a range or an array of `frames`.
8+
* @property {integer} [zeroPad=0] - The minimum expected lengths of each resulting frame's number. Numbers will be left-padded with zeroes until they are this long, then prepended and appended to create the resulting frame name.
9+
* @property {Phaser.Animations.Types.AnimationFrame[]} [outputArray=[]] - The array to append the created configuration objects to.
10+
* @property {boolean} [frames=false] - If provided as an array, the range defined by `start` and `end` will be ignored and these frame numbers will be used.
11+
*/
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/**
2+
* @typedef {object} Phaser.Animations.Types.GenerateFrameNumbers
3+
*
4+
* @property {integer} [start=0] - The starting frame of the animation.
5+
* @property {integer} [end=-1] - The ending frame of the animation.
6+
* @property {(boolean|integer)} [first=false] - A frame to put at the beginning of the animation, before `start` or `outputArray` or `frames`.
7+
* @property {Phaser.Animations.Types.AnimationFrame[]} [outputArray=[]] - An array to concatenate the output onto.
8+
* @property {(boolean|integer[])} [frames=false] - A custom sequence of frames.
9+
*/

0 commit comments

Comments
 (0)