Skip to content

Commit a727437

Browse files
committed
Changed options and sub options of Graphics constructor in docs to be optional
1 parent 19eb363 commit a727437

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
@@ -19,27 +19,27 @@ var Render = require('./GraphicsRender');
1919
*
2020
* @typedef {object} GraphicsLineStyle
2121
*
22-
* @property {number} width - The stroke width.
23-
* @property {number} color - The stroke color.
24-
* @property {number} alpha - The stroke alpha.
22+
* @property {number} [width] - The stroke width.
23+
* @property {number} [color] - The stroke color.
24+
* @property {number} [alpha] - The stroke alpha.
2525
*/
2626

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

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

4545
/**
@@ -48,8 +48,8 @@ var Render = require('./GraphicsRender');
4848
* @typedef {object} GraphicsOptions
4949
* @extends GraphicsStyles
5050
*
51-
* @property {number} x - The x coordinate of the Graphics.
52-
* @property {number} y - The y coordinate of the Graphics.
51+
* @property {number} [x] - The x coordinate of the Graphics.
52+
* @property {number} [y] - The y coordinate of the Graphics.
5353
*/
5454

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

0 commit comments

Comments
 (0)