Skip to content

Commit 622fd7c

Browse files
authored
Merge pull request phaserjs#3745 from cyantree/feature/update-graphics-jsdoc
Changed options and sub options of `Graphics` constructor in docs to …
2 parents 62661b4 + a727437 commit 622fd7c

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

src/gameobjects/graphics/Graphics.js

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,27 +20,27 @@ var Render = require('./GraphicsRender');
2020
*
2121
* @typedef {object} GraphicsLineStyle
2222
*
23-
* @property {number} width - The stroke width.
24-
* @property {number} color - The stroke color.
25-
* @property {number} alpha - The stroke alpha.
23+
* @property {number} [width] - The stroke width.
24+
* @property {number} [color] - The stroke color.
25+
* @property {number} [alpha] - The stroke alpha.
2626
*/
2727

2828
/**
2929
* Graphics fill style settings.
3030
*
3131
* @typedef {object} GraphicsFillStyle
3232
*
33-
* @property {number} color - The fill color.
34-
* @property {number} alpha - The fill alpha.
33+
* @property {number} [color] - The fill color.
34+
* @property {number} [alpha] - The fill alpha.
3535
*/
3636

3737
/**
3838
* Graphics style settings.
3939
*
4040
* @typedef {object} GraphicsStyles
4141
*
42-
* @property {GraphicsLineStyle} lineStyle - The style applied to shape outlines.
43-
* @property {GraphicsFillStyle} fillStyle - The style applied to shape areas.
42+
* @property {GraphicsLineStyle} [lineStyle] - The style applied to shape outlines.
43+
* @property {GraphicsFillStyle} [fillStyle] - The style applied to shape areas.
4444
*/
4545

4646
/**
@@ -49,8 +49,8 @@ var Render = require('./GraphicsRender');
4949
* @typedef {object} GraphicsOptions
5050
* @extends GraphicsStyles
5151
*
52-
* @property {number} x - The x coordinate of the Graphics.
53-
* @property {number} y - The y coordinate of the Graphics.
52+
* @property {number} [x] - The x coordinate of the Graphics.
53+
* @property {number} [y] - The y coordinate of the Graphics.
5454
*/
5555

5656
/**
@@ -110,7 +110,7 @@ var Render = require('./GraphicsRender');
110110
* @extends Phaser.GameObjects.Components.ScrollFactor
111111
*
112112
* @param {Phaser.Scene} scene - The Scene to which this Graphics object belongs.
113-
* @param {GraphicsOptions} options - Options that set the position and default style of this Graphics object.
113+
* @param {GraphicsOptions} [options] - Options that set the position and default style of this Graphics object.
114114
*/
115115
var Graphics = new Class({
116116

0 commit comments

Comments
 (0)