Skip to content

Commit d18f523

Browse files
committed
jsdoc fixes.
1 parent 597b828 commit d18f523

2 files changed

Lines changed: 13 additions & 11 deletions

File tree

src/gameobjects/Text.js

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -303,14 +303,14 @@ Phaser.Text.prototype.setShadow = function (x, y, color, blur) {
303303
* Set the style of the text by passing a single style object to it.
304304
*
305305
* @method Phaser.Text.prototype.setStyle
306-
* @param [style] {Object} The style parameters
307-
* @param [style.font='bold 20pt Arial'] {String} The style and size of the font
308-
* @param [style.fill='black'] {Object} A canvas fillstyle that will be used on the text eg 'red', '#00FF00'
309-
* @param [style.align='left'] {String} Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text
310-
* @param [style.stroke='black'] {String} A canvas fillstyle that will be used on the text stroke eg 'blue', '#FCFF00'
311-
* @param [style.strokeThickness=0] {Number} A number that represents the thickness of the stroke. Default is 0 (no stroke)
312-
* @param [style.wordWrap=false] {Boolean} Indicates if word wrap should be used
313-
* @param [style.wordWrapWidth=100] {Number} The width at which text will wrap
306+
* @param {Object} [style] - The style properties to be set on the Text.
307+
* @param {string} [style.font='bold 20pt Arial'] - The style and size of the font.
308+
* @param {string} [style.fill='black'] - A canvas fillstyle that will be used on the text eg 'red', '#00FF00'.
309+
* @param {string} [style.align='left'] - Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text.
310+
* @param {string} [style.stroke='black'] - A canvas stroke style that will be used on the text stroke eg 'blue', '#FCFF00'.
311+
* @param {number} [style.strokeThickness=0] - A number that represents the thickness of the stroke. Default is 0 (no stroke).
312+
* @param {boolean} [style.wordWrap=false] - Indicates if word wrap should be used.
313+
* @param {number} [style.wordWrapWidth=100] - The width in pixels at which text will wrap.
314314
*/
315315
Phaser.Text.prototype.setStyle = function (style) {
316316

@@ -427,6 +427,7 @@ Phaser.Text.prototype.updateText = function () {
427427
* Greedy wrapping algorithm that will wrap words as the line grows longer than its horizontal bounds.
428428
*
429429
* @method Phaser.Text.prototype.runWordWrap
430+
* @param {string} text - The text to perform word wrap detection against.
430431
* @private
431432
*/
432433
Phaser.Text.prototype.runWordWrap = function (text) {

src/input/MSPointer.js

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,9 @@ Phaser.MSPointer.prototype = {
9898

9999
/**
100100
* The function that handles the PointerDown event.
101+
*
101102
* @method Phaser.MSPointer#onPointerDown
102-
* @param {PointerEvent} event
103+
* @param {PointerEvent} event - The native DOM event.
103104
*/
104105
onPointerDown: function (event) {
105106

@@ -118,7 +119,7 @@ Phaser.MSPointer.prototype = {
118119
/**
119120
* The function that handles the PointerMove event.
120121
* @method Phaser.MSPointer#onPointerMove
121-
* @param {PointerEvent } event
122+
* @param {PointerEvent} event - The native DOM event.
122123
*/
123124
onPointerMove: function (event) {
124125

@@ -137,7 +138,7 @@ Phaser.MSPointer.prototype = {
137138
/**
138139
* The function that handles the PointerUp event.
139140
* @method Phaser.MSPointer#onPointerUp
140-
* @param {PointerEvent} event
141+
* @param {PointerEvent} event - The native DOM event.
141142
*/
142143
onPointerUp: function (event) {
143144

0 commit comments

Comments
 (0)