diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index fea6d37..193d31a 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @namespace PIXI - * @param points* {Point[]|number[]|Point...|number...} This can be an array of Points that form the polygon, + * @param points* {Point[]|number[]|...Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new Polygon(new Point(), new Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index fea6d37..193d31a 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @namespace PIXI - * @param points* {Point[]|number[]|Point...|number...} This can be an array of Points that form the polygon, + * @param points* {Point[]|number[]|...Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new Polygon(new Point(), new Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 4b46eb0..446af7e 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -78,7 +78,7 @@ * When there is a WebGL context change * * @private - * + * */ ParticleRenderer.prototype.onContextChange = function () { @@ -164,7 +164,7 @@ /** * Renders the sprite object. * - * @param container {Container || Sprite} the sprite to render using this ParticleRenderer + * @param container {Container|Sprite} the sprite to render using this ParticleRenderer */ ParticleRenderer.prototype.render = function ( container ) { @@ -250,7 +250,7 @@ /** * Creates one particle buffer for each child in the container we want to render and updates internal properties * - * @param container {Container || Sprite} the sprite to render using this ParticleRenderer + * @param container {Container|Sprite} the sprite to render using this ParticleRenderer */ ParticleRenderer.prototype.generateBuffers = function ( container ) { @@ -337,7 +337,7 @@ }; /** - * + * * @param children {Array} the array of display objects to render * @param startIndex {number} the index to start from in the children array * @param amount {number} the amount of children that will have their positions uploaded @@ -369,7 +369,7 @@ }; /** - * + * * @param children {Array} the array of display objects to render * @param startIndex {number} the index to start from in the children array * @param amount {number} the amount of children that will have their rotation uploaded @@ -394,7 +394,7 @@ }; /** - * + * * @param children {Array} the array of display objects to render * @param startIndex {number} the index to start from in the children array * @param amount {number} the amount of children that will have their Uvs uploaded @@ -445,7 +445,7 @@ }; /** - * + * * @param children {Array} the array of display objects to render * @param startIndex {number} the index to start from in the children array * @param amount {number} the amount of children that will have their alpha uploaded diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index fea6d37..193d31a 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @namespace PIXI - * @param points* {Point[]|number[]|Point...|number...} This can be an array of Points that form the polygon, + * @param points* {Point[]|number[]|...Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new Polygon(new Point(), new Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 4b46eb0..446af7e 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -78,7 +78,7 @@ * When there is a WebGL context change * * @private - * + * */ ParticleRenderer.prototype.onContextChange = function () { @@ -164,7 +164,7 @@ /** * Renders the sprite object. * - * @param container {Container || Sprite} the sprite to render using this ParticleRenderer + * @param container {Container|Sprite} the sprite to render using this ParticleRenderer */ ParticleRenderer.prototype.render = function ( container ) { @@ -250,7 +250,7 @@ /** * Creates one particle buffer for each child in the container we want to render and updates internal properties * - * @param container {Container || Sprite} the sprite to render using this ParticleRenderer + * @param container {Container|Sprite} the sprite to render using this ParticleRenderer */ ParticleRenderer.prototype.generateBuffers = function ( container ) { @@ -337,7 +337,7 @@ }; /** - * + * * @param children {Array} the array of display objects to render * @param startIndex {number} the index to start from in the children array * @param amount {number} the amount of children that will have their positions uploaded @@ -369,7 +369,7 @@ }; /** - * + * * @param children {Array} the array of display objects to render * @param startIndex {number} the index to start from in the children array * @param amount {number} the amount of children that will have their rotation uploaded @@ -394,7 +394,7 @@ }; /** - * + * * @param children {Array} the array of display objects to render * @param startIndex {number} the index to start from in the children array * @param amount {number} the amount of children that will have their Uvs uploaded @@ -445,7 +445,7 @@ }; /** - * + * * @param children {Array} the array of display objects to render * @param startIndex {number} the index to start from in the children array * @param amount {number} the amount of children that will have their alpha uploaded diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 3ff6d22..62a8ad0 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -24,7 +24,7 @@ }); /** - * @member {any[]]} + * @member {any[]} */ this.texturePool = []; diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index fea6d37..193d31a 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @namespace PIXI - * @param points* {Point[]|number[]|Point...|number...} This can be an array of Points that form the polygon, + * @param points* {Point[]|number[]|...Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new Polygon(new Point(), new Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 4b46eb0..446af7e 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -78,7 +78,7 @@ * When there is a WebGL context change * * @private - * + * */ ParticleRenderer.prototype.onContextChange = function () { @@ -164,7 +164,7 @@ /** * Renders the sprite object. * - * @param container {Container || Sprite} the sprite to render using this ParticleRenderer + * @param container {Container|Sprite} the sprite to render using this ParticleRenderer */ ParticleRenderer.prototype.render = function ( container ) { @@ -250,7 +250,7 @@ /** * Creates one particle buffer for each child in the container we want to render and updates internal properties * - * @param container {Container || Sprite} the sprite to render using this ParticleRenderer + * @param container {Container|Sprite} the sprite to render using this ParticleRenderer */ ParticleRenderer.prototype.generateBuffers = function ( container ) { @@ -337,7 +337,7 @@ }; /** - * + * * @param children {Array} the array of display objects to render * @param startIndex {number} the index to start from in the children array * @param amount {number} the amount of children that will have their positions uploaded @@ -369,7 +369,7 @@ }; /** - * + * * @param children {Array} the array of display objects to render * @param startIndex {number} the index to start from in the children array * @param amount {number} the amount of children that will have their rotation uploaded @@ -394,7 +394,7 @@ }; /** - * + * * @param children {Array} the array of display objects to render * @param startIndex {number} the index to start from in the children array * @param amount {number} the amount of children that will have their Uvs uploaded @@ -445,7 +445,7 @@ }; /** - * + * * @param children {Array} the array of display objects to render * @param startIndex {number} the index to start from in the children array * @param amount {number} the amount of children that will have their alpha uploaded diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 3ff6d22..62a8ad0 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -24,7 +24,7 @@ }); /** - * @member {any[]]} + * @member {any[]} */ this.texturePool = []; diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 73b785e..931da21 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -8,7 +8,7 @@ * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. * @param [uniforms] {object} Uniforms for this shader. - * @param [attributes] {obje=ct} Attributes for this shader. + * @param [attributes] {object} Attributes for this shader. */ function Shader(shaderManager, vertexSrc, fragmentSrc, uniforms, attributes) { @@ -18,20 +18,21 @@ } /** - * @member {number} + * @member number * @readonly */ this.uuid = utils.uuid(); /** - * @member {WebGLRenderingContext} + * @member WebGLRenderingContext * @readonly */ this.gl = shaderManager.renderer.gl; /** * The WebGL program. - * @member {WebGLProgram} + * + * @member WebGLProgram * @readonly */ this.program = null; @@ -44,12 +45,15 @@ /** * The vertex shader. - * @member {Array} + * + * @member Array */ this.vertexSrc = vertexSrc; + /** * The fragment shader. - * @member {Array} + * + * @member Array */ this.fragmentSrc = fragmentSrc; diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index fea6d37..193d31a 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @namespace PIXI - * @param points* {Point[]|number[]|Point...|number...} This can be an array of Points that form the polygon, + * @param points* {Point[]|number[]|...Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new Polygon(new Point(), new Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 4b46eb0..446af7e 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -78,7 +78,7 @@ * When there is a WebGL context change * * @private - * + * */ ParticleRenderer.prototype.onContextChange = function () { @@ -164,7 +164,7 @@ /** * Renders the sprite object. * - * @param container {Container || Sprite} the sprite to render using this ParticleRenderer + * @param container {Container|Sprite} the sprite to render using this ParticleRenderer */ ParticleRenderer.prototype.render = function ( container ) { @@ -250,7 +250,7 @@ /** * Creates one particle buffer for each child in the container we want to render and updates internal properties * - * @param container {Container || Sprite} the sprite to render using this ParticleRenderer + * @param container {Container|Sprite} the sprite to render using this ParticleRenderer */ ParticleRenderer.prototype.generateBuffers = function ( container ) { @@ -337,7 +337,7 @@ }; /** - * + * * @param children {Array} the array of display objects to render * @param startIndex {number} the index to start from in the children array * @param amount {number} the amount of children that will have their positions uploaded @@ -369,7 +369,7 @@ }; /** - * + * * @param children {Array} the array of display objects to render * @param startIndex {number} the index to start from in the children array * @param amount {number} the amount of children that will have their rotation uploaded @@ -394,7 +394,7 @@ }; /** - * + * * @param children {Array} the array of display objects to render * @param startIndex {number} the index to start from in the children array * @param amount {number} the amount of children that will have their Uvs uploaded @@ -445,7 +445,7 @@ }; /** - * + * * @param children {Array} the array of display objects to render * @param startIndex {number} the index to start from in the children array * @param amount {number} the amount of children that will have their alpha uploaded diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 3ff6d22..62a8ad0 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -24,7 +24,7 @@ }); /** - * @member {any[]]} + * @member {any[]} */ this.texturePool = []; diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 73b785e..931da21 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -8,7 +8,7 @@ * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. * @param [uniforms] {object} Uniforms for this shader. - * @param [attributes] {obje=ct} Attributes for this shader. + * @param [attributes] {object} Attributes for this shader. */ function Shader(shaderManager, vertexSrc, fragmentSrc, uniforms, attributes) { @@ -18,20 +18,21 @@ } /** - * @member {number} + * @member number * @readonly */ this.uuid = utils.uuid(); /** - * @member {WebGLRenderingContext} + * @member WebGLRenderingContext * @readonly */ this.gl = shaderManager.renderer.gl; /** * The WebGL program. - * @member {WebGLProgram} + * + * @member WebGLProgram * @readonly */ this.program = null; @@ -44,12 +45,15 @@ /** * The vertex shader. - * @member {Array} + * + * @member Array */ this.vertexSrc = vertexSrc; + /** * The fragment shader. - * @member {Array} + * + * @member Array */ this.fragmentSrc = fragmentSrc; diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index b567a29..9c961c3 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -65,7 +65,8 @@ /** * private cache of the bound function - * @type {[type]} + * + * @member function */ this._updateBound = this.update.bind(this); } @@ -97,7 +98,7 @@ * * @member * @memberof MovieClip# - * + * */ textures: { get: function () diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index fea6d37..193d31a 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @namespace PIXI - * @param points* {Point[]|number[]|Point...|number...} This can be an array of Points that form the polygon, + * @param points* {Point[]|number[]|...Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new Polygon(new Point(), new Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 4b46eb0..446af7e 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -78,7 +78,7 @@ * When there is a WebGL context change * * @private - * + * */ ParticleRenderer.prototype.onContextChange = function () { @@ -164,7 +164,7 @@ /** * Renders the sprite object. * - * @param container {Container || Sprite} the sprite to render using this ParticleRenderer + * @param container {Container|Sprite} the sprite to render using this ParticleRenderer */ ParticleRenderer.prototype.render = function ( container ) { @@ -250,7 +250,7 @@ /** * Creates one particle buffer for each child in the container we want to render and updates internal properties * - * @param container {Container || Sprite} the sprite to render using this ParticleRenderer + * @param container {Container|Sprite} the sprite to render using this ParticleRenderer */ ParticleRenderer.prototype.generateBuffers = function ( container ) { @@ -337,7 +337,7 @@ }; /** - * + * * @param children {Array} the array of display objects to render * @param startIndex {number} the index to start from in the children array * @param amount {number} the amount of children that will have their positions uploaded @@ -369,7 +369,7 @@ }; /** - * + * * @param children {Array} the array of display objects to render * @param startIndex {number} the index to start from in the children array * @param amount {number} the amount of children that will have their rotation uploaded @@ -394,7 +394,7 @@ }; /** - * + * * @param children {Array} the array of display objects to render * @param startIndex {number} the index to start from in the children array * @param amount {number} the amount of children that will have their Uvs uploaded @@ -445,7 +445,7 @@ }; /** - * + * * @param children {Array} the array of display objects to render * @param startIndex {number} the index to start from in the children array * @param amount {number} the amount of children that will have their alpha uploaded diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 3ff6d22..62a8ad0 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -24,7 +24,7 @@ }); /** - * @member {any[]]} + * @member {any[]} */ this.texturePool = []; diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 73b785e..931da21 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -8,7 +8,7 @@ * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. * @param [uniforms] {object} Uniforms for this shader. - * @param [attributes] {obje=ct} Attributes for this shader. + * @param [attributes] {object} Attributes for this shader. */ function Shader(shaderManager, vertexSrc, fragmentSrc, uniforms, attributes) { @@ -18,20 +18,21 @@ } /** - * @member {number} + * @member number * @readonly */ this.uuid = utils.uuid(); /** - * @member {WebGLRenderingContext} + * @member WebGLRenderingContext * @readonly */ this.gl = shaderManager.renderer.gl; /** * The WebGL program. - * @member {WebGLProgram} + * + * @member WebGLProgram * @readonly */ this.program = null; @@ -44,12 +45,15 @@ /** * The vertex shader. - * @member {Array} + * + * @member Array */ this.vertexSrc = vertexSrc; + /** * The fragment shader. - * @member {Array} + * + * @member Array */ this.fragmentSrc = fragmentSrc; diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index b567a29..9c961c3 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -65,7 +65,8 @@ /** * private cache of the bound function - * @type {[type]} + * + * @member function */ this._updateBound = this.update.bind(this); } @@ -97,7 +98,7 @@ * * @member * @memberof MovieClip# - * + * */ textures: { get: function () diff --git a/src/interaction/InteractionManager.js b/src/interaction/InteractionManager.js index ad7001a..94c52e0 100644 --- a/src/interaction/InteractionManager.js +++ b/src/interaction/InteractionManager.js @@ -255,7 +255,7 @@ * Dispatches an event on the display object that was interacted with * @param displayObject {Container|Sprite|TilingSprite} the display object in question * @param eventString {string} the name of the event (e.g, mousedown) - * @param eventData {EventData} the event data object + * @param eventData {EventData} the event data object * @private */ InteractionManager.prototype.dispatchEvent = function ( displayObject, eventString, eventData ) @@ -297,7 +297,7 @@ /** * Maps x and y coords from a DOM object and maps them correctly to the pixi view. The resulting value is stored in the point. * This takes into account the fact that the DOM element could be scaled and positioned anywhere on the screen. - * + * * @param {Point} point the point that the result will be stored in * @param {number} x the x coord of the position to map * @param {number} y the y coord of the position to map @@ -312,7 +312,7 @@ /** * This function is provides a neat way of crawling through the scene graph and running a specified function on all interactive objects it finds. * It will also take care of hit testing the interactive objects and passes the hit across in the function. - * + * * @param {Point} point the point that is tested for collision * @param {Container|Sprite|TilingSprite} displayObject the displayObject that will be hit test (recurcsivly crawls its children) * @param {function} func the function that will be called on each interactive object. The displayObject and hit will be passed to the function @@ -618,8 +618,8 @@ /** * [onTouchEnd description] - * @param {[type]} event [description] - * + * @param event {type} [description] + * */ InteractionManager.prototype.onTouchEnd = function (event) { @@ -727,7 +727,7 @@ * Grabs an interaction data object from the internal pool * * @param touchEvent {} The touch event we need to pair with a touchData object - * + * * @private */ InteractionManager.prototype.getTouchData = function (touchEvent) @@ -749,7 +749,7 @@ * Returns an interaction data object to the internal pool * * @param touchEvent {InteractionData} The touch data object we want to return to the pool - * + * * @private */ InteractionManager.prototype.returnTouchData = function ( touchData )