diff --git a/packages/core/src/textures/resources/VideoResource.js b/packages/core/src/textures/resources/VideoResource.js index 6eaafd1..840290f 100644 --- a/packages/core/src/textures/resources/VideoResource.js +++ b/packages/core/src/textures/resources/VideoResource.js @@ -101,9 +101,9 @@ /** * Trigger updating of the texture * - * @param {number} deltaTime - time delta since last tick + * @param {number} [deltaTime=0] - time delta since last tick */ - update(deltaTime) + update(deltaTime = 0) { if (!this.destroyed) { @@ -123,7 +123,7 @@ * Start preloading the video resource. * * @protected - * @return {Promise} Handle the validate event + * @return {Promise} Handle the validate event */ load() { diff --git a/packages/core/src/textures/resources/VideoResource.js b/packages/core/src/textures/resources/VideoResource.js index 6eaafd1..840290f 100644 --- a/packages/core/src/textures/resources/VideoResource.js +++ b/packages/core/src/textures/resources/VideoResource.js @@ -101,9 +101,9 @@ /** * Trigger updating of the texture * - * @param {number} deltaTime - time delta since last tick + * @param {number} [deltaTime=0] - time delta since last tick */ - update(deltaTime) + update(deltaTime = 0) { if (!this.destroyed) { @@ -123,7 +123,7 @@ * Start preloading the video resource. * * @protected - * @return {Promise} Handle the validate event + * @return {Promise} Handle the validate event */ load() { diff --git a/packages/text/src/TextMetrics.js b/packages/text/src/TextMetrics.js index 7e7e715..2898894 100644 --- a/packages/text/src/TextMetrics.js +++ b/packages/text/src/TextMetrics.js @@ -516,7 +516,7 @@ * * @static * @param {string} font - String representing the style of the font - * @return {PIXI.TextMetrics.FontMetrics} Font properties object + * @return {PIXI.IFontMetrics} Font properties object */ static measureFont(font) { @@ -737,3 +737,13 @@ 0x205F, // medium mathematical space 0x3000, // ideographic space ]; + +/** + * A number, or a string containing a number. + * @memberof PIXI + * @typedef IFontMetrics + * @property {number} ascent - Font ascent + * @property {number} descent - Font descent + * @property {number} fontSize - Font size + */ + diff --git a/packages/core/src/textures/resources/VideoResource.js b/packages/core/src/textures/resources/VideoResource.js index 6eaafd1..840290f 100644 --- a/packages/core/src/textures/resources/VideoResource.js +++ b/packages/core/src/textures/resources/VideoResource.js @@ -101,9 +101,9 @@ /** * Trigger updating of the texture * - * @param {number} deltaTime - time delta since last tick + * @param {number} [deltaTime=0] - time delta since last tick */ - update(deltaTime) + update(deltaTime = 0) { if (!this.destroyed) { @@ -123,7 +123,7 @@ * Start preloading the video resource. * * @protected - * @return {Promise} Handle the validate event + * @return {Promise} Handle the validate event */ load() { diff --git a/packages/text/src/TextMetrics.js b/packages/text/src/TextMetrics.js index 7e7e715..2898894 100644 --- a/packages/text/src/TextMetrics.js +++ b/packages/text/src/TextMetrics.js @@ -516,7 +516,7 @@ * * @static * @param {string} font - String representing the style of the font - * @return {PIXI.TextMetrics.FontMetrics} Font properties object + * @return {PIXI.IFontMetrics} Font properties object */ static measureFont(font) { @@ -737,3 +737,13 @@ 0x205F, // medium mathematical space 0x3000, // ideographic space ]; + +/** + * A number, or a string containing a number. + * @memberof PIXI + * @typedef IFontMetrics + * @property {number} ascent - Font ascent + * @property {number} descent - Font descent + * @property {number} fontSize - Font size + */ + diff --git a/packages/ticker/src/Ticker.js b/packages/ticker/src/Ticker.js index 2546cee..ec44107 100644 --- a/packages/ticker/src/Ticker.js +++ b/packages/ticker/src/Ticker.js @@ -223,7 +223,7 @@ * it is removed or the ticker is stopped. * * @param {Function} fn - The listener function to be added for updates - * @param {Function} [context] - The listener context + * @param {*} [context] - The listener context * @param {number} [priority=PIXI.UPDATE_PRIORITY.NORMAL] - The priority for emitting * @returns {PIXI.Ticker} This instance of a ticker */ @@ -236,7 +236,7 @@ * Add a handler for the tick event which is only execute once. * * @param {Function} fn - The listener function to be added for one update - * @param {Function} [context] - The listener context + * @param {*} [context] - The listener context * @param {number} [priority=PIXI.UPDATE_PRIORITY.NORMAL] - The priority for emitting * @returns {PIXI.Ticker} This instance of a ticker */ @@ -296,7 +296,7 @@ * If no handlers are left after removing, then it cancels the animation frame. * * @param {Function} fn - The listener function to be removed - * @param {Function} [context] - The listener context to be removed + * @param {*} [context] - The listener context to be removed * @returns {PIXI.Ticker} This instance of a ticker */ remove(fn, context) diff --git a/packages/core/src/textures/resources/VideoResource.js b/packages/core/src/textures/resources/VideoResource.js index 6eaafd1..840290f 100644 --- a/packages/core/src/textures/resources/VideoResource.js +++ b/packages/core/src/textures/resources/VideoResource.js @@ -101,9 +101,9 @@ /** * Trigger updating of the texture * - * @param {number} deltaTime - time delta since last tick + * @param {number} [deltaTime=0] - time delta since last tick */ - update(deltaTime) + update(deltaTime = 0) { if (!this.destroyed) { @@ -123,7 +123,7 @@ * Start preloading the video resource. * * @protected - * @return {Promise} Handle the validate event + * @return {Promise} Handle the validate event */ load() { diff --git a/packages/text/src/TextMetrics.js b/packages/text/src/TextMetrics.js index 7e7e715..2898894 100644 --- a/packages/text/src/TextMetrics.js +++ b/packages/text/src/TextMetrics.js @@ -516,7 +516,7 @@ * * @static * @param {string} font - String representing the style of the font - * @return {PIXI.TextMetrics.FontMetrics} Font properties object + * @return {PIXI.IFontMetrics} Font properties object */ static measureFont(font) { @@ -737,3 +737,13 @@ 0x205F, // medium mathematical space 0x3000, // ideographic space ]; + +/** + * A number, or a string containing a number. + * @memberof PIXI + * @typedef IFontMetrics + * @property {number} ascent - Font ascent + * @property {number} descent - Font descent + * @property {number} fontSize - Font size + */ + diff --git a/packages/ticker/src/Ticker.js b/packages/ticker/src/Ticker.js index 2546cee..ec44107 100644 --- a/packages/ticker/src/Ticker.js +++ b/packages/ticker/src/Ticker.js @@ -223,7 +223,7 @@ * it is removed or the ticker is stopped. * * @param {Function} fn - The listener function to be added for updates - * @param {Function} [context] - The listener context + * @param {*} [context] - The listener context * @param {number} [priority=PIXI.UPDATE_PRIORITY.NORMAL] - The priority for emitting * @returns {PIXI.Ticker} This instance of a ticker */ @@ -236,7 +236,7 @@ * Add a handler for the tick event which is only execute once. * * @param {Function} fn - The listener function to be added for one update - * @param {Function} [context] - The listener context + * @param {*} [context] - The listener context * @param {number} [priority=PIXI.UPDATE_PRIORITY.NORMAL] - The priority for emitting * @returns {PIXI.Ticker} This instance of a ticker */ @@ -296,7 +296,7 @@ * If no handlers are left after removing, then it cancels the animation frame. * * @param {Function} fn - The listener function to be removed - * @param {Function} [context] - The listener context to be removed + * @param {*} [context] - The listener context to be removed * @returns {PIXI.Ticker} This instance of a ticker */ remove(fn, context) diff --git a/packages/ticker/src/TickerListener.js b/packages/ticker/src/TickerListener.js index 2bdb362..b6174f3 100644 --- a/packages/ticker/src/TickerListener.js +++ b/packages/ticker/src/TickerListener.js @@ -11,7 +11,7 @@ * Constructor * @private * @param {Function} fn - The listener function to be added for one update - * @param {Function} [context=null] - The listener context + * @param {*} [context=null] - The listener context * @param {number} [priority=0] - The priority for emitting * @param {boolean} [once=false] - If the handler should fire once */ @@ -27,7 +27,7 @@ /** * The calling to execute. * @private - * @member {Function} + * @member {*} */ this.context = context;