diff --git a/gulp/util/jsdoc.conf.json b/gulp/util/jsdoc.conf.json index 377b716..15bb1d6 100644 --- a/gulp/util/jsdoc.conf.json +++ b/gulp/util/jsdoc.conf.json @@ -7,6 +7,7 @@ "./src/" ], "exclude": [ + "./src/polyfill/", "./src/core/utils/PolyK.js", "./src/spine/SpineRuntime.js" ], diff --git a/gulp/util/jsdoc.conf.json b/gulp/util/jsdoc.conf.json index 377b716..15bb1d6 100644 --- a/gulp/util/jsdoc.conf.json +++ b/gulp/util/jsdoc.conf.json @@ -7,6 +7,7 @@ "./src/" ], "exclude": [ + "./src/polyfill/", "./src/core/utils/PolyK.js", "./src/spine/SpineRuntime.js" ], diff --git a/gulpfile.js b/gulpfile.js index 4ff5a4e..3d29ac5 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -30,6 +30,3 @@ // default task gulp.task('default', ['jshint', 'build']); - -// you can directly use 'gulp jsdocs' to generate the docs -gulp.task('docs',['jsdocs']); \ No newline at end of file diff --git a/gulp/util/jsdoc.conf.json b/gulp/util/jsdoc.conf.json index 377b716..15bb1d6 100644 --- a/gulp/util/jsdoc.conf.json +++ b/gulp/util/jsdoc.conf.json @@ -7,6 +7,7 @@ "./src/" ], "exclude": [ + "./src/polyfill/", "./src/core/utils/PolyK.js", "./src/spine/SpineRuntime.js" ], diff --git a/gulpfile.js b/gulpfile.js index 4ff5a4e..3d29ac5 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -30,6 +30,3 @@ // default task gulp.task('default', ['jshint', 'build']); - -// you can directly use 'gulp jsdocs' to generate the docs -gulp.task('docs',['jsdocs']); \ No newline at end of file diff --git a/package.json b/package.json index d9bd7a9..9778919 100644 --- a/package.json +++ b/package.json @@ -17,7 +17,7 @@ }, "scripts": { "test": "gulp test", - "docs": "./node_modules/.bin/jsdoc -c ./gulp/util/jsdoc.conf.json -R README.md" + "docs": "jsdoc -c ./gulp/util/jsdoc.conf.json -R README.md" }, "dependencies": { "async": "^0.9.0", @@ -34,7 +34,6 @@ "gulp-cached": "^1.0.1", "gulp-concat": "^2.5.2", "gulp-debug": "^2.0.0", - "gulp-jsdoc": "^0.1.4", "gulp-jshint": "^1.9.0", "gulp-mirror": "^0.4.0", "gulp-plumber": "^0.6.6", diff --git a/gulp/util/jsdoc.conf.json b/gulp/util/jsdoc.conf.json index 377b716..15bb1d6 100644 --- a/gulp/util/jsdoc.conf.json +++ b/gulp/util/jsdoc.conf.json @@ -7,6 +7,7 @@ "./src/" ], "exclude": [ + "./src/polyfill/", "./src/core/utils/PolyK.js", "./src/spine/SpineRuntime.js" ], diff --git a/gulpfile.js b/gulpfile.js index 4ff5a4e..3d29ac5 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -30,6 +30,3 @@ // default task gulp.task('default', ['jshint', 'build']); - -// you can directly use 'gulp jsdocs' to generate the docs -gulp.task('docs',['jsdocs']); \ No newline at end of file diff --git a/package.json b/package.json index d9bd7a9..9778919 100644 --- a/package.json +++ b/package.json @@ -17,7 +17,7 @@ }, "scripts": { "test": "gulp test", - "docs": "./node_modules/.bin/jsdoc -c ./gulp/util/jsdoc.conf.json -R README.md" + "docs": "jsdoc -c ./gulp/util/jsdoc.conf.json -R README.md" }, "dependencies": { "async": "^0.9.0", @@ -34,7 +34,6 @@ "gulp-cached": "^1.0.1", "gulp-concat": "^2.5.2", "gulp-debug": "^2.0.0", - "gulp-jsdoc": "^0.1.4", "gulp-jshint": "^1.9.0", "gulp-mirror": "^0.4.0", "gulp-plumber": "^0.6.6", diff --git a/src/deprecation.js b/src/deprecation.js index c873997..b28df18 100644 --- a/src/deprecation.js +++ b/src/deprecation.js @@ -1,61 +1,109 @@ +/*global console */ var core = require('./core'), mesh = require('./mesh'), text = require('./text'); - +/** + * @class + * @name PIXI.SpriteBatch + * @see {@link PIXI.ParticleContainer} + * @throws {ReferenceError} SpriteBatch does not exist any more, please use the new ParticleContainer instead. + */ core.SpriteBatch = function () { - window.console.warn('SpriteBatch does not exist any more, please use the new ParticleContainer instead.'); + throw new ReferenceError('SpriteBatch does not exist any more, please use the new ParticleContainer instead.'); }; +/** + * @class + * @name PIXI.AssetLoader + * @see {@link PIXI.Loader} + * @throws {ReferenceError} The loader system was overhauled in pixi v3, please see the new PIXI.Loader class. + */ core.AssetLoader = function () { - window.console.warn('The loader system was overhauled in pixi v3, please see the new PIXI.Loader class.'); + throw new ReferenceError('The loader system was overhauled in pixi v3, please see the new PIXI.Loader class.'); }; Object.defineProperties(core, { + /** + * @class + * @name PIXI.Stage + * @see {@link PIXI.Container} + * @deprecated since version 3.0 + */ Stage: { get: function () { - window.console.warn('You do not need to use a PIXI Stage any more, you can simply render any container.'); + console.warn('You do not need to use a PIXI Stage any more, you can simply render any container.'); return core.Container; } }, + /** + * @class + * @name PIXI.DisplayObjectContainer + * @see {@link PIXI.Container} + * @deprecated since version 3.0 + */ DisplayObjectContainer: { get: function () { - window.console.warn('DisplayObjectContainer has been shortened to Container, please use Container from now on'); + console.warn('DisplayObjectContainer has been shortened to Container, please use Container from now on.'); return core.Container; } }, + /** + * @class + * @name PIXI.Strip + * @see {@link PIXI.Mesh} + * @deprecated since version 3.0 + */ Strip: { get: function () { - window.console.warn('The Strip class has been renamed to Mesh, please use Mesh from now on'); + console.warn('The Strip class has been renamed to Mesh, please use Mesh from now on.'); return mesh.Mesh; } } }); +/** + * @method + * @name PIXI.Sprite#setTexture + * @see {@link PIXI.Sprite#texture} + * @deprecated since version 3.0 + */ core.Sprite.prototype.setTexture = function (texture) { this.texture = texture; - window.console.warn('setTexture is now deprecated, please use the texture property, e.g : sprite.texture = texture;'); + console.warn('setTexture is now deprecated, please use the texture property, e.g : sprite.texture = texture;'); }; +/** + * @method + * @name PIXI.BitmapText#setText + * @see {@link PIXI.BitmapText#text} + * @deprecated since version 3.0 + */ text.BitmapText.prototype.setText = function (text) { this.text = text; - window.console.warn('setText is now deprecated, please use the text property, e.g : myBitmapText.text = \'my text\';'); + console.warn('setText is now deprecated, please use the text property, e.g : myBitmapText.text = \'my text\';'); }; +/** + * @method + * @name PIXI.Text#setText + * @see {@link PIXI.Text#text} + * @deprecated since version 3.0 + */ text.Text.prototype.setText = function (text) { this.text = text; - window.console.warn('setText is now deprecated, please use the text property, e.g : myText.text = \'my text\';'); + console.warn('setText is now deprecated, please use the text property, e.g : myText.text = \'my text\';'); }; module.exports = {};