Skip to content

Commit fd9cf6c

Browse files
committed
Added jsdocs
1 parent eaca4eb commit fd9cf6c

7 files changed

Lines changed: 372 additions & 8 deletions

File tree

src/boot/Game.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ var Game = new Class({
5555
/**
5656
* A reference to either the Canvas or WebGL Renderer that this Game is using.
5757
*
58-
* @property {Phaser.Renderer.CanvasRenderer|Phaser.Renderer.WebGLRenderer} renderer
58+
* @property {Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer} renderer
5959
* @since 3.0.0
6060
*/
6161
this.renderer = null;

src/scene/GetPhysicsPlugins.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
var GetFastValue = require('../utils/object/GetFastValue');
22
var UppercaseFirst = require('../utils/string/UppercaseFirst');
33

4+
/**
5+
* Builds an array of which physics plugins should be activated for the given Scene.
6+
*
7+
* @function Phaser.Scenes.GetPhysicsPlugins
8+
* @since 3.0.0
9+
*
10+
* @param {Phaser.Scenes.Systems} sys - [description]
11+
*
12+
* @return {array} [description]
13+
*/
414
var GetPhysicsPlugins = function (sys)
515
{
616
var defaultSystem = sys.game.config.defaultPhysicsSystem;

src/scene/GetScenePlugins.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
var GetFastValue = require('../utils/object/GetFastValue');
22

3+
/**
4+
* Builds an array of which plugins (not including physics plugins) should be activated for the given Scene.
5+
*
6+
* @function Phaser.Scenes.GetScenePlugins
7+
* @since 3.0.0
8+
*
9+
* @param {Phaser.Scenes.Systems} sys - [description]
10+
*
11+
* @return {array} [description]
12+
*/
313
var GetScenePlugins = function (sys)
414
{
515
var defaultPlugins = sys.game.config.defaultPlugins;

src/scene/Scene.js

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,40 @@
11
var Class = require('../utils/Class');
22
var Systems = require('./Systems');
33

4+
/**
5+
* @classdesc
6+
* [description]
7+
*
8+
* @class Scene
9+
* @memberOf Phaser
10+
* @constructor
11+
* @since 3.0.0
12+
*
13+
* @param {object} config - [description]
14+
*/
415
var Scene = new Class({
516

617
initialize:
718

819
function Scene (config)
920
{
10-
// The Scene Systems. You must never overwrite this property, or all hell will break lose.
21+
/**
22+
* The Scene Systems. You must never overwrite this property, or all hell will break lose.
23+
*
24+
* @name Phaser.Scene#sys
25+
* @type {Phaser.Scenes.Systems}
26+
* @since 3.0.0
27+
*/
1128
this.sys = new Systems(this, config);
1229
},
1330

14-
// Should be overridden by your own Scenes
31+
/**
32+
* Should be overridden by your own Scenes.
33+
*
34+
* @method Phaser.Scene#update
35+
* @override
36+
* @since 3.0.0
37+
*/
1538
update: function ()
1639
{
1740
}

src/scene/Settings.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@ var CONST = require('./const');
22
var GetValue = require('../utils/object/GetValue');
33
var InjectionMap = require('./InjectionMap');
44

5+
/**
6+
* Takes a Scene configuration object and returns a fully formed Systems object.
7+
*
8+
* @function Phaser.Scenes.Settings.create
9+
* @since 3.0.0
10+
*
11+
* @param {object} config - [description]
12+
*
13+
* @return {object} [description]
14+
*/
515
var Settings = {
616

717
create: function (config)

0 commit comments

Comments
 (0)