Skip to content

Commit 8fc31ed

Browse files
committed
Doc formatting
1 parent 1c311a7 commit 8fc31ed

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

Phaser/Stage.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,16 +68,19 @@ module Phaser {
6868
* Local private reference to game.
6969
*/
7070
private _game: Game;
71+
7172
/**
7273
* Background color of the stage.
7374
* @type {string}
7475
*/
7576
private _bgColor: string;
77+
7678
/**
7779
* This will be displayed when Phaser is started without any default functions or State
7880
* @type {BootScreen}
7981
*/
8082
private _bootScreen;
83+
8184
/**
8285
* This will be displayed whenever the game loses focus or the player switches to another browser tab.
8386
* @type {PauseScreen}
@@ -89,6 +92,7 @@ module Phaser {
8992
* @type {number}
9093
*/
9194
public static ORIENTATION_LANDSCAPE: number = 0;
95+
9296
/**
9397
* Screen orientation enum: Portrait.
9498
* @type {number}
@@ -100,48 +104,57 @@ module Phaser {
100104
* @type {Rectangle}
101105
*/
102106
public bounds: Rectangle;
107+
103108
/**
104109
* Asperct ratio, thus: width / height.
105110
* @type {number}
106111
*/
107112
public aspectRatio: number;
113+
108114
/**
109115
* Clear the whole stage every frame? (Default to true)
110116
* @type {boolean}
111117
*/
112118
public clear: bool = true;
119+
113120
/**
114121
* Canvas element used by engine.
115122
* @type {HTMLCanvasElement}
116123
*/
117124
public canvas: HTMLCanvasElement;
125+
118126
/**
119127
* Render context of stage's canvas.
120128
* @type {CanvasRenderingContext2D}
121129
*/
122130
public context: CanvasRenderingContext2D;
131+
123132
/**
124133
* Do not use pause screen when game is paused?
125134
* (Default to false, aka always use PauseScreen)
126135
* @type {boolean}
127136
*/
128137
public disablePauseScreen: bool = false;
138+
129139
/**
130140
* Do not use boot screen when engine starts?
131141
* (Default to false, aka always use BootScreen)
132142
* @type {boolean}
133143
*/
134144
public disableBootScreen: bool = false;
145+
135146
/**
136147
* Offset from this stage to the canvas element.
137148
* @type {Point}
138149
*/
139150
public offset: Point;
151+
140152
/**
141153
* This object manages scaling of the game, see(StageScaleMode).
142154
* @type {StageScaleMode}
143155
*/
144156
public scale: StageScaleMode;
157+
145158
/**
146159
* Which mode will the game be scaled.
147160
* Available: StageScaleMode.EXACT_FIT, StageScaleMode.NO_SCALE, StageScaleMode.SHOW_ALL.
@@ -154,16 +167,19 @@ module Phaser {
154167
* @type {number}
155168
*/
156169
public minScaleX: number = null;
170+
157171
/**
158172
* Maximal scale factor of x-axis.
159173
* @type {number}
160174
*/
161175
public maxScaleX: number = null;
176+
162177
/**
163178
* Minimal scale factor of y-axis.
164179
* @type {number}
165180
*/
166181
public minScaleY: number = null;
182+
167183
/**
168184
* Maximal scale factor of y-axis.
169185
* @type {number}
@@ -247,11 +263,13 @@ module Phaser {
247263
* @type {string}
248264
*/
249265
public strokeStyle: string;
266+
250267
/**
251268
* Canvas lineWidth.
252269
* @type {number}
253270
*/
254271
public lineWidth: number;
272+
255273
/**
256274
* Canvas fillStyle.
257275
* @type {string}

0 commit comments

Comments
 (0)