Fixed jsdoc in labelgraphics.js.

This commit is contained in:
Sebastian Kupke 2019-03-29 08:48:03 +01:00
parent 909c67cfba
commit 5a963844d8

View File

@ -114,8 +114,8 @@ export class Hypenate {
* @param {*} text * @param {*} text
* @param {*} style * @param {*} style
* @param {*} width * @param {*} width
* @returns
* @memberof Hypenate * @memberof Hypenate
* @returns {string}
*/ */
static splitLines(text, style, width) { static splitLines(text, style, width) {
const pixiStyle = new PIXI.TextStyle(style) const pixiStyle = new PIXI.TextStyle(style)
@ -135,7 +135,7 @@ class TextLabel extends PIXI.Text {
/** /**
*Creates an instance of TextLabel. *Creates an instance of TextLabel.
* @param {string} text - The string that you would like the text to display * @param {string} text - The string that you would like the text to display
* @param {object PIXI.TextStyle optional} style - The style parameters * @param {object|PIXI.TextStyle} [style] - The style parameters
* @param {canvas} * @param {canvas}
* @memberof TextLabel * @memberof TextLabel
*/ */
@ -209,7 +209,7 @@ export class LabeledGraphics extends PIXI.Graphics {
* maxHeight: {number} truncates text that needs more space and adds ellipsis * maxHeight: {number} truncates text that needs more space and adds ellipsis
* maxWidth: {number} word wraps text using hyphenation if possible * maxWidth: {number} word wraps text using hyphenation if possible
* @param {*} [fontInfo=FontInfo.normal] - Defines PIXI.TextStyle attributes * @param {*} [fontInfo=FontInfo.normal] - Defines PIXI.TextStyle attributes
* @returns {PIXI.Text} instance * @returns {PIXI.Text} - instance
* @memberof LabeledGraphics * @memberof LabeledGraphics
*/ */
ensureLabel(key, label, attrs = {}, fontInfo = FontInfo.normal) { ensureLabel(key, label, attrs = {}, fontInfo = FontInfo.normal) {
@ -278,7 +278,7 @@ export class LabeledGraphics extends PIXI.Graphics {
* @param {*} text * @param {*} text
* @param {*} style * @param {*} style
* @param {*} [maxLines=Infinity] * @param {*} [maxLines=Infinity]
* @returns * @returns {string}
* @memberof LabeledGraphics * @memberof LabeledGraphics
*/ */
truncateLabel(text, style, maxLines = Infinity) { truncateLabel(text, style, maxLines = Infinity) {
@ -314,7 +314,7 @@ export class LabeledGraphics extends PIXI.Graphics {
* Returns the label for the given key. * Returns the label for the given key.
* *
* @param {*} key * @param {*} key
* @returns * @returns {Object}
* @memberof LabeledGraphics * @memberof LabeledGraphics
*/ */
getLabel(key) { getLabel(key) {
@ -411,4 +411,4 @@ export class BitmapLabeledGraphics extends LabeledGraphics {
return new SpriteLabel(texture) return new SpriteLabel(texture)
} }
} }