Skip to content

Commit dc332f1

Browse files
committed
JSDocs added for whole Spine Plugin
1 parent d995122 commit dc332f1

6 files changed

Lines changed: 693 additions & 197 deletions

File tree

plugins/spine/src/SpineFile.js

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ var TextFile = require('../../../src/loader/filetypes/TextFile.js');
3939
* @constructor
4040
*
4141
* @param {Phaser.Loader.LoaderPlugin} loader - A reference to the Loader that is responsible for this file.
42-
* @param {(string|Phaser.Loader.FileTypes.UnityAtlasFileConfig)} key - The key to use for this file, or a file configuration object.
43-
* @param {string|string[]} [textureURL] - The absolute or relative URL to load the texture image file from. If undefined or `null` it will be set to `<key>.png`, i.e. if `key` was "alien" then the URL will be "alien.png".
42+
* @param {(string|Phaser.Loader.FileTypes.SpineFileConfig)} key - The key to use for this file, or a file configuration object.
43+
* @param {string|string[]} [jsonURL] - The absolute or relative URL to load the JSON file from. If undefined or `null` it will be set to `<key>.json`, i.e. if `key` was "alien" then the URL will be "alien.json".
4444
* @param {string} [atlasURL] - The absolute or relative URL to load the texture atlas data file from. If undefined or `null` it will be set to `<key>.txt`, i.e. if `key` was "alien" then the URL will be "alien.txt".
45-
* @param {boolean} [preMultipliedAlpha=false] -
46-
* @param {XHRSettingsObject} [textureXhrSettings] - An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings.
45+
* @param {boolean} [preMultipliedAlpha=false] - Do the textures contain pre-multiplied alpha or not?
46+
* @param {XHRSettingsObject} [jsonXhrSettings] - An XHR Settings configuration object for the json file. Used in replacement of the Loaders default XHR Settings.
4747
* @param {XHRSettingsObject} [atlasXhrSettings] - An XHR Settings configuration object for the atlas data file. Used in replacement of the Loaders default XHR Settings.
4848
*/
4949
var SpineFile = new Class({
@@ -89,11 +89,10 @@ var SpineFile = new Class({
8989
key: key,
9090
url: atlasURL[i],
9191
extension: GetFastValue(config, 'atlasExtension', 'atlas'),
92-
xhrSettings: GetFastValue(config, 'atlasXhrSettings'),
92+
xhrSettings: GetFastValue(config, 'atlasXhrSettings')
9393
});
9494

9595
atlas.cache = cache;
96-
// atlas.config.preMultipliedAlpha = preMultipliedAlpha;
9796

9897
files.push(atlas);
9998
}
@@ -111,7 +110,6 @@ var SpineFile = new Class({
111110
{
112111
atlas = new TextFile(loader, key + '_' + i, atlasURL[i], atlasXhrSettings);
113112
atlas.cache = cache;
114-
// atlas.config.preMultipliedAlpha = preMultipliedAlpha;
115113

116114
files.push(atlas);
117115
}
@@ -127,8 +125,8 @@ var SpineFile = new Class({
127125
/**
128126
* Called by each File when it finishes loading.
129127
*
130-
* @method Phaser.Loader.MultiFile#onFileComplete
131-
* @since 3.7.0
128+
* @method Phaser.Loader.FileTypes.SpineFile#onFileComplete
129+
* @since 3.19.0
132130
*
133131
* @param {Phaser.Loader.File} file - The File that has completed processing.
134132
*/
@@ -201,7 +199,7 @@ var SpineFile = new Class({
201199
* Adds this file to its target cache upon successful loading and processing.
202200
*
203201
* @method Phaser.Loader.FileTypes.SpineFile#addToCache
204-
* @since 3.16.0
202+
* @since 3.19.0
205203
*/
206204
addToCache: function ()
207205
{

0 commit comments

Comments
 (0)