Skip to content

Commit 3c655bf

Browse files
committed
Improved jsdocs
1 parent 14ae8ec commit 3c655bf

3 files changed

Lines changed: 198 additions & 66 deletions

File tree

src/core/Config.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -204,12 +204,12 @@ var Config = new Class({
204204
// DOM Element Container
205205

206206
/**
207-
* @const {?boolean} Phaser.Core.Config#domCreateContainer - EXPERIMENTAL: Do not currently use.
207+
* @const {?boolean} Phaser.Core.Config#domCreateContainer - Should the game create a div element to act as a DOM Container? Only enable if you're using DOM Element objects. You must provide a parent object if you use this feature.
208208
*/
209209
this.domCreateContainer = GetValue(config, 'dom.createContainer', false);
210210

211211
/**
212-
* @const {?boolean} Phaser.Core.Config#domBehindCanvas - EXPERIMENTAL: Do not currently use.
212+
* @const {?boolean} Phaser.Core.Config#domBehindCanvas - Should the DOM Container that is created (if `dom.createContainer` is true) be positioned behind (true) or over the top (false, the default) of the game canvas?
213213
*/
214214
this.domBehindCanvas = GetValue(config, 'dom.behindCanvas', false);
215215

src/core/typedefs/DOMContainerConfig.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
* @typedef {object} Phaser.Core.Types.DOMContainerConfig
33
* @since 3.12.0
44
*
5-
* @property {boolean} [createContainer=false] - Create a div element in which DOM Elements will be contained. You must also provide a parent.
6-
* @property {boolean} [behindCanvas=false] - Place the DOM Container behind the Phaser Canvas. The default is to place it over the Canvas.
5+
* @property {boolean} [createContainer=false] - Should the game create a div element to act as a DOM Container? Only enable if you're using DOM Element objects. You must provide a parent object if you use this feature.
6+
* @property {boolean} [behindCanvas=false] - Should the DOM Container that is created (if `dom.createContainer` is true) be positioned behind (true) or over the top (false, the default) of the game canvas?
77
*/

0 commit comments

Comments
 (0)