diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index d24a420..a8e2ae4 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -55,7 +55,7 @@ /** * Setting this to true will visually show the divs * - * @type {Boolean} + * @type {boolean} */ this.debug = false; diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index d24a420..a8e2ae4 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -55,7 +55,7 @@ /** * Setting this to true will visually show the divs * - * @type {Boolean} + * @type {boolean} */ this.debug = false; diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index d73d089..43a47b2 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index d24a420..a8e2ae4 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -55,7 +55,7 @@ /** * Setting this to true will visually show the divs * - * @type {Boolean} + * @type {boolean} */ this.debug = false; diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index d73d089..43a47b2 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 18dd8c1..41db39a 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -194,11 +194,11 @@ /** * Renders the object to its webGL view * - * @param displayObject {core.DisplayObject} the object to be rendered - * @param renderTexture {core.RenderTexture} - * @param clear {Boolean} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} + * @param clear {boolean} * @param transform {PIXI.Transform} - * @param skipUpdateTransform {Boolean} + * @param skipUpdateTransform {boolean} */ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index d24a420..a8e2ae4 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -55,7 +55,7 @@ /** * Setting this to true will visually show the divs * - * @type {Boolean} + * @type {boolean} */ this.debug = false; diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index d73d089..43a47b2 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 18dd8c1..41db39a 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -194,11 +194,11 @@ /** * Renders the object to its webGL view * - * @param displayObject {core.DisplayObject} the object to be rendered - * @param renderTexture {core.RenderTexture} - * @param clear {Boolean} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} + * @param clear {boolean} * @param transform {PIXI.Transform} - * @param skipUpdateTransform {Boolean} + * @param skipUpdateTransform {boolean} */ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { diff --git a/src/core/renderers/webgl/WebGLState.js b/src/core/renderers/webgl/WebGLState.js index cc76ad0..003efc1 100755 --- a/src/core/renderers/webgl/WebGLState.js +++ b/src/core/renderers/webgl/WebGLState.js @@ -35,7 +35,7 @@ /** * The stack holding all the different states * - * @member {array} + * @member {*[]} * @private */ this.stack = []; diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index d24a420..a8e2ae4 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -55,7 +55,7 @@ /** * Setting this to true will visually show the divs * - * @type {Boolean} + * @type {boolean} */ this.debug = false; diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index d73d089..43a47b2 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 18dd8c1..41db39a 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -194,11 +194,11 @@ /** * Renders the object to its webGL view * - * @param displayObject {core.DisplayObject} the object to be rendered - * @param renderTexture {core.RenderTexture} - * @param clear {Boolean} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} + * @param clear {boolean} * @param transform {PIXI.Transform} - * @param skipUpdateTransform {Boolean} + * @param skipUpdateTransform {boolean} */ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { diff --git a/src/core/renderers/webgl/WebGLState.js b/src/core/renderers/webgl/WebGLState.js index cc76ad0..003efc1 100755 --- a/src/core/renderers/webgl/WebGLState.js +++ b/src/core/renderers/webgl/WebGLState.js @@ -35,7 +35,7 @@ /** * The stack holding all the different states * - * @member {array} + * @member {*[]} * @private */ this.stack = []; diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 15836da..0067f78 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -18,7 +18,7 @@ /** * Changes the mask stack that is used by this manager. * - * @param stencilMaskStack {*[]} The mask stack + * @param stencilMaskStack {PIXI.Graphics[]} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index d24a420..a8e2ae4 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -55,7 +55,7 @@ /** * Setting this to true will visually show the divs * - * @type {Boolean} + * @type {boolean} */ this.debug = false; diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index d73d089..43a47b2 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 18dd8c1..41db39a 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -194,11 +194,11 @@ /** * Renders the object to its webGL view * - * @param displayObject {core.DisplayObject} the object to be rendered - * @param renderTexture {core.RenderTexture} - * @param clear {Boolean} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} + * @param clear {boolean} * @param transform {PIXI.Transform} - * @param skipUpdateTransform {Boolean} + * @param skipUpdateTransform {boolean} */ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { diff --git a/src/core/renderers/webgl/WebGLState.js b/src/core/renderers/webgl/WebGLState.js index cc76ad0..003efc1 100755 --- a/src/core/renderers/webgl/WebGLState.js +++ b/src/core/renderers/webgl/WebGLState.js @@ -35,7 +35,7 @@ /** * The stack holding all the different states * - * @member {array} + * @member {*[]} * @private */ this.stack = []; diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 15836da..0067f78 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -18,7 +18,7 @@ /** * Changes the mask stack that is used by this manager. * - * @param stencilMaskStack {*[]} The mask stack + * @param stencilMaskStack {PIXI.Graphics[]} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index ef1c280..d8349cf 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -46,7 +46,7 @@ /** * The background colour of this render target, as an array of [r,g,b,a] values * - * @member {array} + * @member {number[]} */ this.clearColor = [0, 0, 0, 0]; @@ -104,7 +104,7 @@ /** * The data structure for the stencil masks * - * @member {array} + * @member {PIXI.Graphics[]} */ this.stencilMaskStack = []; @@ -179,7 +179,7 @@ /** * Clears the filter texture. * - * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer + * @param [clearColor=this.clearColor] {number[]} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index d24a420..a8e2ae4 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -55,7 +55,7 @@ /** * Setting this to true will visually show the divs * - * @type {Boolean} + * @type {boolean} */ this.debug = false; diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index d73d089..43a47b2 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 18dd8c1..41db39a 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -194,11 +194,11 @@ /** * Renders the object to its webGL view * - * @param displayObject {core.DisplayObject} the object to be rendered - * @param renderTexture {core.RenderTexture} - * @param clear {Boolean} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} + * @param clear {boolean} * @param transform {PIXI.Transform} - * @param skipUpdateTransform {Boolean} + * @param skipUpdateTransform {boolean} */ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { diff --git a/src/core/renderers/webgl/WebGLState.js b/src/core/renderers/webgl/WebGLState.js index cc76ad0..003efc1 100755 --- a/src/core/renderers/webgl/WebGLState.js +++ b/src/core/renderers/webgl/WebGLState.js @@ -35,7 +35,7 @@ /** * The stack holding all the different states * - * @member {array} + * @member {*[]} * @private */ this.stack = []; diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 15836da..0067f78 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -18,7 +18,7 @@ /** * Changes the mask stack that is used by this manager. * - * @param stencilMaskStack {*[]} The mask stack + * @param stencilMaskStack {PIXI.Graphics[]} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index ef1c280..d8349cf 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -46,7 +46,7 @@ /** * The background colour of this render target, as an array of [r,g,b,a] values * - * @member {array} + * @member {number[]} */ this.clearColor = [0, 0, 0, 0]; @@ -104,7 +104,7 @@ /** * The data structure for the stencil masks * - * @member {array} + * @member {PIXI.Graphics[]} */ this.stencilMaskStack = []; @@ -179,7 +179,7 @@ /** * Clears the filter texture. * - * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer + * @param [clearColor=this.clearColor] {number[]} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/utils/index.js b/src/core/utils/index.js index ed6e552..2fd81ef 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -172,7 +172,7 @@ /** * removeItems * - * @param {array} arr The target array + * @param {*[]} arr The target array * @param {number} startIdx The index to begin removing from (inclusive) * @param {number} removeCount How many items to remove */ diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index d24a420..a8e2ae4 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -55,7 +55,7 @@ /** * Setting this to true will visually show the divs * - * @type {Boolean} + * @type {boolean} */ this.debug = false; diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index d73d089..43a47b2 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 18dd8c1..41db39a 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -194,11 +194,11 @@ /** * Renders the object to its webGL view * - * @param displayObject {core.DisplayObject} the object to be rendered - * @param renderTexture {core.RenderTexture} - * @param clear {Boolean} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} + * @param clear {boolean} * @param transform {PIXI.Transform} - * @param skipUpdateTransform {Boolean} + * @param skipUpdateTransform {boolean} */ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { diff --git a/src/core/renderers/webgl/WebGLState.js b/src/core/renderers/webgl/WebGLState.js index cc76ad0..003efc1 100755 --- a/src/core/renderers/webgl/WebGLState.js +++ b/src/core/renderers/webgl/WebGLState.js @@ -35,7 +35,7 @@ /** * The stack holding all the different states * - * @member {array} + * @member {*[]} * @private */ this.stack = []; diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 15836da..0067f78 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -18,7 +18,7 @@ /** * Changes the mask stack that is used by this manager. * - * @param stencilMaskStack {*[]} The mask stack + * @param stencilMaskStack {PIXI.Graphics[]} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index ef1c280..d8349cf 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -46,7 +46,7 @@ /** * The background colour of this render target, as an array of [r,g,b,a] values * - * @member {array} + * @member {number[]} */ this.clearColor = [0, 0, 0, 0]; @@ -104,7 +104,7 @@ /** * The data structure for the stencil masks * - * @member {array} + * @member {PIXI.Graphics[]} */ this.stencilMaskStack = []; @@ -179,7 +179,7 @@ /** * Clears the filter texture. * - * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer + * @param [clearColor=this.clearColor] {number[]} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/utils/index.js b/src/core/utils/index.js index ed6e552..2fd81ef 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -172,7 +172,7 @@ /** * removeItems * - * @param {array} arr The target array + * @param {*[]} arr The target array * @param {number} startIdx The index to begin removing from (inclusive) * @param {number} removeCount How many items to remove */ diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 4c5369f..b7ae916 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -1,5 +1,4 @@ var core = require('../core'); - /** * A MovieClip is a simple way to display an animation depicted by a list of textures. * @@ -16,12 +15,15 @@ * var mc = new PIXI.MovieClip(textureArray); * ``` * + * @typedef FrameObject + * @type {object} + * @property texture {PIXI.Texture} The {@link PIXI.Texture} of the frame + * @property time {number} the duration of the frame in ms + * * @class * @extends PIXI.Sprite * @memberof PIXI.extras - * @param textures {PIXI.Texture[]|Object[]} an array of {@link PIXI.Texture} or frame objects that make up the animation - * @param textures[].texture {PIXI.Texture} the {@link PIXI.Texture} of the frame - * @param textures[].time {number} the duration of the frame in ms + * @param textures {PIXI.Texture[]|FrameObject[]} an array of {@link PIXI.Texture} or frame objects that make up the animation */ function MovieClip(textures) { @@ -316,4 +318,4 @@ } return new MovieClip(textures); -}; \ No newline at end of file +}; diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index d24a420..a8e2ae4 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -55,7 +55,7 @@ /** * Setting this to true will visually show the divs * - * @type {Boolean} + * @type {boolean} */ this.debug = false; diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index d73d089..43a47b2 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 18dd8c1..41db39a 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -194,11 +194,11 @@ /** * Renders the object to its webGL view * - * @param displayObject {core.DisplayObject} the object to be rendered - * @param renderTexture {core.RenderTexture} - * @param clear {Boolean} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} + * @param clear {boolean} * @param transform {PIXI.Transform} - * @param skipUpdateTransform {Boolean} + * @param skipUpdateTransform {boolean} */ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { diff --git a/src/core/renderers/webgl/WebGLState.js b/src/core/renderers/webgl/WebGLState.js index cc76ad0..003efc1 100755 --- a/src/core/renderers/webgl/WebGLState.js +++ b/src/core/renderers/webgl/WebGLState.js @@ -35,7 +35,7 @@ /** * The stack holding all the different states * - * @member {array} + * @member {*[]} * @private */ this.stack = []; diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 15836da..0067f78 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -18,7 +18,7 @@ /** * Changes the mask stack that is used by this manager. * - * @param stencilMaskStack {*[]} The mask stack + * @param stencilMaskStack {PIXI.Graphics[]} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index ef1c280..d8349cf 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -46,7 +46,7 @@ /** * The background colour of this render target, as an array of [r,g,b,a] values * - * @member {array} + * @member {number[]} */ this.clearColor = [0, 0, 0, 0]; @@ -104,7 +104,7 @@ /** * The data structure for the stencil masks * - * @member {array} + * @member {PIXI.Graphics[]} */ this.stencilMaskStack = []; @@ -179,7 +179,7 @@ /** * Clears the filter texture. * - * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer + * @param [clearColor=this.clearColor] {number[]} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/utils/index.js b/src/core/utils/index.js index ed6e552..2fd81ef 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -172,7 +172,7 @@ /** * removeItems * - * @param {array} arr The target array + * @param {*[]} arr The target array * @param {number} startIdx The index to begin removing from (inclusive) * @param {number} removeCount How many items to remove */ diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 4c5369f..b7ae916 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -1,5 +1,4 @@ var core = require('../core'); - /** * A MovieClip is a simple way to display an animation depicted by a list of textures. * @@ -16,12 +15,15 @@ * var mc = new PIXI.MovieClip(textureArray); * ``` * + * @typedef FrameObject + * @type {object} + * @property texture {PIXI.Texture} The {@link PIXI.Texture} of the frame + * @property time {number} the duration of the frame in ms + * * @class * @extends PIXI.Sprite * @memberof PIXI.extras - * @param textures {PIXI.Texture[]|Object[]} an array of {@link PIXI.Texture} or frame objects that make up the animation - * @param textures[].texture {PIXI.Texture} the {@link PIXI.Texture} of the frame - * @param textures[].time {number} the duration of the frame in ms + * @param textures {PIXI.Texture[]|FrameObject[]} an array of {@link PIXI.Texture} or frame objects that make up the animation */ function MovieClip(textures) { @@ -316,4 +318,4 @@ } return new MovieClip(textures); -}; \ No newline at end of file +}; diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index 20acc6b..bd7ea14 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -9,7 +9,7 @@ * @class * @extends PIXI.Sprite * @memberof PIXI.extras - * @param texture {core.Texture} the texture of the tiling sprite + * @param texture {PIXI.Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite */