Skip to content

Commit 9e0f113

Browse files
committed
Added jsdocs
1 parent 67132a6 commit 9e0f113

2 files changed

Lines changed: 8 additions & 2 deletions

File tree

src/textures/parsers/SpriteSheet.js

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,13 @@ var GetFastValue = require('../../utils/object/GetFastValue');
2222
* @param {integer} y - [description]
2323
* @param {integer} width - [description]
2424
* @param {integer} height - [description]
25-
* @param {object} config - [description]
25+
* @param {object} config - An object describing how to parse the Sprite Sheet.
26+
* @param {number} config.frameWidth - Width in pixels of a single frame in the sprite sheet.
27+
* @param {number} [config.frameHeight] - Height in pixels of a single frame in the sprite sheet. Defaults to frameWidth if not provided.
28+
* @param {number} [config.startFrame=0] - [description]
29+
* @param {number} [config.endFrame=-1] - [description]
30+
* @param {number} [config.margin=0] - If the frames have been drawn with a margin, specify the amount here.
31+
* @param {number} [config.spacing=0] - If the frames have been drawn with spacing between them, specify the amount here.
2632
*
2733
* @return {Phaser.Textures.Texture} The Texture modified by this parser.
2834
*/

src/textures/parsers/SpriteSheetFromAtlas.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ var GetFastValue = require('../../utils/object/GetFastValue');
1313
* same size and cannot be trimmed or rotated.
1414
*
1515
* @function Phaser.Textures.Parsers.SpriteSheetFromAtlas
16-
* @memberof Phaser.Textures.Parsers
16+
* @memberOf Phaser.Textures.Parsers
1717
* @since 3.0.0
1818
*
1919
* @param {Phaser.Textures.Texture} texture - The Texture to add the Frames to.

0 commit comments

Comments
 (0)