diff --git a/src/animations/index.js b/src/animations/index.js index 228eea4fe..1c7faa24a 100644 --- a/src/animations/index.js +++ b/src/animations/index.js @@ -1,4 +1,6 @@ -// Phaser.Animations +/** + * @namespace Phaser.Animations + */ module.exports = { diff --git a/src/boot/index.js b/src/boot/index.js new file mode 100644 index 000000000..929e9cbf2 --- /dev/null +++ b/src/boot/index.js @@ -0,0 +1,13 @@ +/** + * @namespace Phaser.Boot + */ + +module.exports = { + + Config: require('./Config'), + CreateRenderer: require('./CreateRenderer'), + DebugHeader: require('./DebugHeader'), + TimeStep: require('./TimeStep'), + VisibilityHandler: require('./VisibilityHandler') + +}; diff --git a/src/cache/index.js b/src/cache/index.js index cf7e6c02f..cf664c2de 100644 --- a/src/cache/index.js +++ b/src/cache/index.js @@ -1,4 +1,6 @@ -// Phaser.Cache +/** + * @namespace Phaser.Cache + */ module.exports = { diff --git a/src/cameras/2d/index.js b/src/cameras/2d/index.js index a6d010528..d73fcc5dc 100644 --- a/src/cameras/2d/index.js +++ b/src/cameras/2d/index.js @@ -1,4 +1,6 @@ -// Phaser.Cameras.Scene2D +/** + * @namespace Phaser.Cameras.Scene2D + */ module.exports = { diff --git a/src/cameras/controls/index.js b/src/cameras/controls/index.js index 465f27df6..86b4c1c44 100644 --- a/src/cameras/controls/index.js +++ b/src/cameras/controls/index.js @@ -1,4 +1,6 @@ -// Phaser.Cameras.Controls +/** + * @namespace Phaser.Cameras.Controls + */ module.exports = { diff --git a/src/cameras/index.js b/src/cameras/index.js index 65146ddcc..39e15b10d 100644 --- a/src/cameras/index.js +++ b/src/cameras/index.js @@ -1,4 +1,6 @@ -// Phaser.Cameras +/** + * @namespace Phaser.Cameras + */ module.exports = { diff --git a/src/cameras/sprite3d/index.js b/src/cameras/sprite3d/index.js index a7ab5f734..d7030e955 100644 --- a/src/cameras/sprite3d/index.js +++ b/src/cameras/sprite3d/index.js @@ -1,4 +1,6 @@ -// Phaser.Cameras.Sprite3D +/** + * @namespace Phaser.Cameras.Sprite3D + */ module.exports = { diff --git a/src/create/index.js b/src/create/index.js index 5467b02bd..2ab1d4a7c 100644 --- a/src/create/index.js +++ b/src/create/index.js @@ -1,4 +1,6 @@ -// Phaser.Create +/** + * @namespace Phaser.Create + */ module.exports = { diff --git a/src/curves/index.js b/src/curves/index.js index d23f1c9ae..e6ea61a35 100644 --- a/src/curves/index.js +++ b/src/curves/index.js @@ -1,4 +1,6 @@ -// Phaser.Curves +/** + * @namespace Phaser.Curves + */ module.exports = { diff --git a/src/data/index.js b/src/data/index.js index d9b39d2af..de352960c 100644 --- a/src/data/index.js +++ b/src/data/index.js @@ -1,4 +1,6 @@ -// Phaser.Data +/** + * @namespace Phaser.Data + */ module.exports = { diff --git a/src/device/index.js b/src/device/index.js index 6beb52086..09548d1d7 100644 --- a/src/device/index.js +++ b/src/device/index.js @@ -3,7 +3,9 @@ // Which means all instances of Phaser Games can share it, // without having to re-poll the device all over again -// Phaser.Device +/** + * @namespace Phaser.Device + */ module.exports = { diff --git a/src/display/align/in/index.js b/src/display/align/in/index.js index 538c5a2ed..e0690af06 100644 --- a/src/display/align/in/index.js +++ b/src/display/align/in/index.js @@ -1,4 +1,6 @@ -// Phaser.Display.Align.In +/** + * @namespace Phaser.Display.Align.In + */ module.exports = { diff --git a/src/display/align/index.js b/src/display/align/index.js index 080f6022f..9c880093b 100644 --- a/src/display/align/index.js +++ b/src/display/align/index.js @@ -1,4 +1,6 @@ -// Phaser.Display.Align +/** + * @namespace Phaser.Display.Align + */ module.exports = { diff --git a/src/display/align/to/index.js b/src/display/align/to/index.js index 286e8d1ce..bca163055 100644 --- a/src/display/align/to/index.js +++ b/src/display/align/to/index.js @@ -1,4 +1,6 @@ -// Phaser.Display.Align.To +/** + * @namespace Phaser.Display.Align.To + */ module.exports = { diff --git a/src/display/bounds/index.js b/src/display/bounds/index.js index 57383d50f..1bddd60e9 100644 --- a/src/display/bounds/index.js +++ b/src/display/bounds/index.js @@ -1,4 +1,6 @@ -// Phaser.Display.Bounds +/** + * @namespace Phaser.Display.Bounds + */ module.exports = { diff --git a/src/display/canvas/index.js b/src/display/canvas/index.js index fd06874fe..3500b9546 100644 --- a/src/display/canvas/index.js +++ b/src/display/canvas/index.js @@ -1,4 +1,6 @@ -// Phaser.Display.Canvas +/** + * @namespace Phaser.Display.Canvas + */ module.exports = { diff --git a/src/display/color/index.js b/src/display/color/index.js index c4aba17c9..c32db7df0 100644 --- a/src/display/color/index.js +++ b/src/display/color/index.js @@ -1,4 +1,6 @@ -// Phaser.Display.Color +/** + * @namespace Phaser.Display.Color + */ var Color = require('./Color'); diff --git a/src/display/index.js b/src/display/index.js index e3ed99aaf..a4dc5efb2 100644 --- a/src/display/index.js +++ b/src/display/index.js @@ -1,4 +1,6 @@ -// Phaser.Display +/** + * @namespace Phaser.Display + */ module.exports = { diff --git a/src/display/mask/index.js b/src/display/mask/index.js index 9f16ee229..a31dc1c32 100644 --- a/src/display/mask/index.js +++ b/src/display/mask/index.js @@ -1,3 +1,6 @@ +/** + * @namespace Phaser.Display.Masks + */ module.exports = { diff --git a/src/dom/index.js b/src/dom/index.js index f9f682255..962412b22 100644 --- a/src/dom/index.js +++ b/src/dom/index.js @@ -1,4 +1,6 @@ -// Phaser.DOM +/** + * @namespace Phaser.DOM + */ module.exports = { diff --git a/src/events/EventEmitter.js b/src/events/EventEmitter.js index 396f32898..ba7961a10 100644 --- a/src/events/EventEmitter.js +++ b/src/events/EventEmitter.js @@ -2,6 +2,10 @@ var Class = require('../utils/Class'); var EE = require('eventemitter3'); var PluginManager = require('../plugins/PluginManager'); +/** + * @namespace Phaser.Events + */ + var EventEmitter = new Class({ Extends: EE, diff --git a/src/gameobjects/GameObject.js b/src/gameobjects/GameObject.js index 4cd6e6a18..3d411c4bc 100644 --- a/src/gameobjects/GameObject.js +++ b/src/gameobjects/GameObject.js @@ -3,24 +3,25 @@ var Components = require('./components'); var DataManager = require('../data/DataManager'); var EventEmitter = require('eventemitter3'); +/** + * The base class that all Game Objects extend. + * You don't create GameObjects directly and they cannot be added to the display list. + * Instead, use them as the base for your own custom classes. + * + * @class GameObject + * @memberOf Phaser.GameObjects + * @constructor + * @since 3.0.0 + * + * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. + * @param {string} type - A textual representation of the type of Game Object, i.e. `sprite`. + */ var GameObject = new Class({ Extends: EventEmitter, initialize: - /** - * The base class that all Game Objects extend. - * You don't create GameObjects directly and they cannot be added to the display list. - * Instead, use them as the base for your own custom classes. - * - * @class GameObject - * @memberof Phaser.GameObjects - * @constructor - * - * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. - * @param {string} type - A textual representation of the type of Game Object, i.e. `sprite`. - */ function GameObject (scene, type) { EventEmitter.call(this); @@ -31,6 +32,7 @@ var GameObject = new Class({ * * @property {Phaser.Scene} scene * @protected + * @since 3.0.0 */ this.scene = scene; @@ -39,6 +41,7 @@ var GameObject = new Class({ * Used internally by Phaser but is available for your own custom classes to populate. * * @property {string} type + * @since 3.0.0 */ this.type = type; @@ -47,6 +50,7 @@ var GameObject = new Class({ * Empty by default and never populated by Phaser, this is left for developers to use. * * @property {string} [name=''] + * @since 3.0.0 */ this.name = ''; @@ -56,6 +60,7 @@ var GameObject = new Class({ * An active object is one which is having its logic and internal systems updated. * * @property {boolean} [active=true] + * @since 3.0.0 */ this.active = true; @@ -64,6 +69,7 @@ var GameObject = new Class({ * Reserved for future use by plugins and the Input Manager. * * @property {integer} [tabIndex=-1] + * @since 3.0.0 */ this.tabIndex = -1; @@ -73,6 +79,7 @@ var GameObject = new Class({ * `null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`. * * @property {Phaser.Data.DataManager} data + * @since 3.0.0 */ this.data = null; @@ -82,6 +89,7 @@ var GameObject = new Class({ * If those components are not used by your custom class then you can use this bitmask as you wish. * * @property {integer} [renderFlags=15] + * @since 3.0.0 */ this.renderFlags = 15; @@ -91,6 +99,7 @@ var GameObject = new Class({ * * @property {number} [cameraFilter=0] * @see Phaser.Cameras.Camera.ignore + * @since 3.0.0 */ this.cameraFilter = 0; @@ -100,6 +109,7 @@ var GameObject = new Class({ * * @property {?Phaser.Input.InteractiveObject} [input=null] * @see setInteractive + * @since 3.0.0 */ this.input = null; @@ -107,6 +117,7 @@ var GameObject = new Class({ * If this Game Object is enabled for physics then this property will contain a reference to a Physics Body. * * @property {?Phaser.Physics.Body} [body=null] + * @since 3.0.0 */ this.body = null; @@ -118,10 +129,12 @@ var GameObject = new Class({ * Sets the `active` property of this Game Object and returns this Game Object for further chaining. * A Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList. * - * @method setActive + * @method Phaser.GameObjects.GameObject#setActive + * @since 3.0.0 * * @param {boolean} value - True if this Game Object should be set as active, false if not. - * @return {GameObject} This GameObject. + * + * @return {Phaser.GameObjects.GameObject} This GameObject. */ setActive: function (value) { @@ -134,13 +147,12 @@ var GameObject = new Class({ * Sets the `name` property of this Game Object and returns this Game Object for further chaining. * The `name` property is not populated by Phaser and is presented for your own use. * - * @example game objects/image/set name.js - * @tutorial game objects/basics - * - * @method setName + * @method Phaser.GameObjects.GameObject#setName + * @since 3.0.0 * * @param {string} value - The name to be given to this Game Object. - * @return {GameObject} This GameObject. + * + * @return {Phaser.GameObjects.GameObject} This GameObject. */ setName: function (value) { @@ -149,6 +161,14 @@ var GameObject = new Class({ return this; }, + /** + * [description] + * + * @method Phaser.GameObjects.GameObject#setDataEnabled + * @since 3.0.0 + * + * @return {Phaser.GameObjects.GameObject} This GameObject. + */ setDataEnabled: function () { if (!this.data) @@ -163,11 +183,13 @@ var GameObject = new Class({ * This is a quick chainable alias to the `DataProxy.set` method. * It allows you to set a key and value in this Game Objects data store. * - * @method setData + * @method Phaser.GameObjects.GameObject#setData + * @since 3.0.0 * * @param {string} key - The key of the property to be stored. * @param {any} value - The value to store with the key. Can be a string, number, array or object. - * @return {GameObject} This GameObject. + * + * @return {Phaser.GameObjects.GameObject} This GameObject. */ setData: function (key, value) { @@ -184,9 +206,11 @@ var GameObject = new Class({ /** * This is a quick alias to the `DataProxy.get` method to remain consistent with `setData`. * - * @method getData + * @method Phaser.GameObjects.GameObject#getData + * @since 3.0.0 * - * @param {string} key - The key of the property to be retrieve. + * @param {string} key - The key of the property to be retrieved. + * * @return {any} The data, if present in the Data Store. */ getData: function (key) @@ -202,14 +226,13 @@ var GameObject = new Class({ /** * Pass this Game Object to the Input Manager to enable it for Input. * - * @example game objects/image/set interactive.js - * @tutorial input/basics - * - * @method setInteractive + * @method Phaser.GameObjects.GameObject#setInteractive + * @since 3.0.0 * * @param {any} [shape] - A geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used. * @param {function} [callback] - A callback to be invoked when the Game Object is interacted with. - * @return {GameObject} This GameObject. + * + * @return {Phaser.GameObjects.GameObject} This GameObject. */ setInteractive: function (shape, callback) { @@ -218,7 +241,12 @@ var GameObject = new Class({ return this; }, - // To be overridden by custom GameObjects. Allows base objects to be used in a Pool. + /** + * To be overridden by custom GameObjects. Allows base objects to be used in a Pool. + * + * @method Phaser.GameObjects.GameObject#update + * @since 3.0.0 + */ update: function () { }, @@ -226,7 +254,8 @@ var GameObject = new Class({ /** * Returns a JSON representation of the Game Object. * - * @method toJSON + * @method Phaser.GameObjects.GameObject#toJSON + * @since 3.0.0 * * @return {object} A JSON representation of the Game Object. */ @@ -238,7 +267,8 @@ var GameObject = new Class({ /** * Compares the renderMask with the renderFlags to see if this Game Object will render or not. * - * @method willRender + * @method Phaser.GameObjects.GameObject#willRender + * @since 3.0.0 * * @return {boolean} True if the Game Object should be rendered, otherwise false. */ @@ -260,7 +290,8 @@ var GameObject = new Class({ * If you just want to temporarily disable an object then look at using the * Game Object Pool instead of destroying it, as destroyed objects cannot be resurrected. * - * @method destroy + * @method Phaser.GameObjects.GameObject#destroy + * @since 3.0.0 */ destroy: function () { diff --git a/src/gameobjects/blitter/Blitter.js b/src/gameobjects/blitter/Blitter.js index 334083bcf..d267185d9 100644 --- a/src/gameobjects/blitter/Blitter.js +++ b/src/gameobjects/blitter/Blitter.js @@ -6,6 +6,28 @@ var DisplayList = require('../DisplayList'); var Frame = require('../../textures/Frame'); var GameObject = require('../GameObject'); +/** + * A Blitter Game Object. + * + * The Blitter Game Object is a special type of Container, that contains Blitter.Bob objects. + * These objects can be thought of as just texture frames with a position and nothing more. + * Bobs don't have any update methods, or the ability to have children, or any kind of special effects. + * They are essentially just super-fast texture frame renderers, and the Blitter object creates and manages them. + * + * @class Blitter + * @extends Phaser.GameObjects.GameObject + * @memberOf Phaser.GameObjects + * @constructor + * @since 3.0.0 + * + * @mixes Phaser.GameObjects.Components.Alpha + * + * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. It can only belong to one Scene at any given time. + * @param {number} [x==] - The x coordinate of this Game Object in world space. + * @param {number} [y=0] - The y coordinate of this Game Object in world space. + * @param {string} [texture='__DEFAULT'] - The key of the texture this Game Object will use for rendering. The Texture must already exist in the Texture Manager. + * @param {string|integer} [frame=0] - The Frame of the Texture that this Game Object will use. Only set if the Texture has multiple frames, such as a Texture Atlas or Sprite Sheet. + */ var Blitter = new Class({ Extends: GameObject, @@ -25,28 +47,6 @@ var Blitter = new Class({ initialize: - /** - * A Blitter Game Object. - * - * The Blitter Game Object is a special type of Container, that contains Blitter.Bob objects. - * These objects can be thought of as just texture frames with a position and nothing more. - * Bobs don't have any update methods, or the ability to have children, or any kind of special effects. - * They are essentially just super-fast texture frame renderers, and the Blitter object creates and manages them. - * - * @class Blitter - * @extends Phaser.GameObjects.GameObject - * @memberOf Phaser.GameObjects - * @constructor - * @since 3.0.0 - * - * @mixes Phaser.GameObjects.Components.Alpha - * - * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. It can only belong to one Scene at any given time. - * @param {number} [x==] - The x coordinate of this Game Object in world space. - * @param {number} [y=0] - The y coordinate of this Game Object in world space. - * @param {string} [texture='__DEFAULT'] - The key of the texture this Game Object will use for rendering. The Texture must already exist in the Texture Manager. - * @param {string|integer} [frame=0] - The Frame of the Texture that this Game Object will use. Only set if the Texture has multiple frames, such as a Texture Atlas or Sprite Sheet. - */ function Blitter (scene, x, y, texture, frame) { GameObject.call(this, scene, 'Blitter'); diff --git a/src/gameobjects/index.js b/src/gameobjects/index.js index ca5a16f5b..07c917baa 100644 --- a/src/gameobjects/index.js +++ b/src/gameobjects/index.js @@ -1,4 +1,6 @@ -// Phaser.GameObjects +/** + * @namespace Phaser.GameObjects + */ var GameObjects = { diff --git a/src/geom/circle/index.js b/src/geom/circle/index.js index a66e49eca..ee7c8e8a4 100644 --- a/src/geom/circle/index.js +++ b/src/geom/circle/index.js @@ -1,4 +1,6 @@ -// Phaser.Geom.Circle +/** + * @namespace Phaser.Geom.Circle + */ var Circle = require('./Circle'); diff --git a/src/geom/ellipse/index.js b/src/geom/ellipse/index.js index aeffb714d..62451934d 100644 --- a/src/geom/ellipse/index.js +++ b/src/geom/ellipse/index.js @@ -1,4 +1,6 @@ -// Phaser.Geom.Ellipse +/** + * @namespace Phaser.Geom.Ellipse + */ var Ellipse = require('./Ellipse'); diff --git a/src/geom/index.js b/src/geom/index.js index f63ba3174..719287050 100644 --- a/src/geom/index.js +++ b/src/geom/index.js @@ -1,4 +1,6 @@ -// Phaser.Geom +/** + * @namespace Phaser.Geom + */ module.exports = { diff --git a/src/geom/intersects/index.js b/src/geom/intersects/index.js index 7191a8c96..57d72b9ad 100644 --- a/src/geom/intersects/index.js +++ b/src/geom/intersects/index.js @@ -1,4 +1,6 @@ -// Phaser.Geom.Intersects +/** + * @namespace Phaser.Geom.Intersects + */ module.exports = { diff --git a/src/geom/line/index.js b/src/geom/line/index.js index b02ec7cd7..d29162ac8 100644 --- a/src/geom/line/index.js +++ b/src/geom/line/index.js @@ -1,4 +1,6 @@ -// Phaser.Geom.Line +/** + * @namespace Phaser.Geom.Line + */ var Line = require('./Line'); diff --git a/src/geom/point/index.js b/src/geom/point/index.js index a719d1658..c21f1381e 100644 --- a/src/geom/point/index.js +++ b/src/geom/point/index.js @@ -1,4 +1,6 @@ -// Phaser.Geom.Point +/** + * @namespace Phaser.Geom.Point + */ var Point = require('./Point'); diff --git a/src/geom/polygon/index.js b/src/geom/polygon/index.js index ae51f5fb1..84b197206 100644 --- a/src/geom/polygon/index.js +++ b/src/geom/polygon/index.js @@ -1,4 +1,6 @@ -// Phaser.Geom.Polygon +/** + * @namespace Phaser.Geom.Polygon + */ var Polygon = require('./Polygon'); diff --git a/src/geom/rectangle/index.js b/src/geom/rectangle/index.js index b1ec75da9..a641a8dbe 100644 --- a/src/geom/rectangle/index.js +++ b/src/geom/rectangle/index.js @@ -1,4 +1,6 @@ -// Phaser.Geom.Rectangle +/** + * @namespace Phaser.Geom.Rectangle + */ var Rectangle = require('./Rectangle'); diff --git a/src/geom/triangle/index.js b/src/geom/triangle/index.js index 16836c0ec..d6c24571c 100644 --- a/src/geom/triangle/index.js +++ b/src/geom/triangle/index.js @@ -1,4 +1,6 @@ -// Phaser.Geom.Triangle +/** + * @namespace Phaser.Geom.Triangle + */ var Triangle = require('./Triangle'); diff --git a/src/input/gamepad/index.js b/src/input/gamepad/index.js index edfd0e57b..86f775681 100644 --- a/src/input/gamepad/index.js +++ b/src/input/gamepad/index.js @@ -1,4 +1,6 @@ -// Phaser.Input.Gamepad +/** + * @namespace Phaser.Input.Gamepad + */ module.exports = { diff --git a/src/input/index.js b/src/input/index.js index f9f210bde..81b4586f7 100644 --- a/src/input/index.js +++ b/src/input/index.js @@ -1,4 +1,6 @@ -// Phaser.Input +/** + * @namespace Phaser.Input + */ module.exports = { diff --git a/src/input/keyboard/index.js b/src/input/keyboard/index.js index 8cc7f7801..c53fe3a22 100644 --- a/src/input/keyboard/index.js +++ b/src/input/keyboard/index.js @@ -1,4 +1,6 @@ -// Phaser.Input.Keyboard +/** + * @namespace Phaser.Input.Keyboard + */ module.exports = { diff --git a/src/input/mouse/index.js b/src/input/mouse/index.js index 525df7754..d97e7a731 100644 --- a/src/input/mouse/index.js +++ b/src/input/mouse/index.js @@ -1,4 +1,6 @@ -// Phaser.Input.Mouse +/** + * @namespace Phaser.Input.Mouse + */ module.exports = { diff --git a/src/input/touch/index.js b/src/input/touch/index.js index 50fb5d782..ec65946ea 100644 --- a/src/input/touch/index.js +++ b/src/input/touch/index.js @@ -1,4 +1,6 @@ -// Phaser.Input.Touch +/** + * @namespace Phaser.Input.Touch + */ module.exports = { diff --git a/src/loader/index.js b/src/loader/index.js index 200160121..14f1c57da 100644 --- a/src/loader/index.js +++ b/src/loader/index.js @@ -1,4 +1,10 @@ -// Phaser.Loader +/** + * @namespace Phaser.Loader + */ + +/** + * @namespace Phaser.Loader.FileTypes + */ module.exports = { diff --git a/src/math/index.js b/src/math/index.js index 3baf037ce..afe6b1db4 100644 --- a/src/math/index.js +++ b/src/math/index.js @@ -1,5 +1,9 @@ var RND = require('./random-data-generator/RandomDataGenerator'); +/** + * @namespace Phaser.Math + */ + module.exports = { // Consts diff --git a/src/phaser.js b/src/phaser.js index 3f8eaa358..53051942c 100644 --- a/src/phaser.js +++ b/src/phaser.js @@ -3,7 +3,9 @@ require('./polyfills'); var CONST = require('./const'); var Extend = require('./utils/object/Extend'); -// This object is exported globally +/** +* @namespace Phaser +*/ var Phaser = { diff --git a/src/physics/index.js b/src/physics/index.js index 096f30cd3..d6f7b8d6b 100644 --- a/src/physics/index.js +++ b/src/physics/index.js @@ -1,4 +1,6 @@ -// Phaser.Physics +/** + * @namespace Phaser.Physics + */ module.exports = { diff --git a/src/plugins/PluginManager.js b/src/plugins/PluginManager.js index f2da83ac9..101b05ab6 100644 --- a/src/plugins/PluginManager.js +++ b/src/plugins/PluginManager.js @@ -2,6 +2,10 @@ var Class = require('../utils/Class'); var plugins = {}; +/** + * @namespace Phaser.Plugins + */ + var PluginManager = new Class({ initialize: diff --git a/src/renderer/canvas/CanvasRenderer.js b/src/renderer/canvas/CanvasRenderer.js index 83a4c9693..c42455651 100644 --- a/src/renderer/canvas/CanvasRenderer.js +++ b/src/renderer/canvas/CanvasRenderer.js @@ -7,6 +7,10 @@ var GetBlendModes = require('./utils/GetBlendModes'); var ScaleModes = require('../ScaleModes'); var Smoothing = require('../../display/canvas/Smoothing'); +/** + * @namespace Phaser.Renderer.CanvasRenderer + */ + var CanvasRenderer = new Class({ initialize: diff --git a/src/renderer/webgl/WebGLRenderer.js b/src/renderer/webgl/WebGLRenderer.js index 6f700e253..f2b4d7727 100644 --- a/src/renderer/webgl/WebGLRenderer.js +++ b/src/renderer/webgl/WebGLRenderer.js @@ -10,6 +10,10 @@ var FlatTintPipeline = require('./pipelines/FlatTintPipeline'); var BitmapMaskPipeline = require('./pipelines/BitmapMaskPipeline'); var ForwardDiffuseLightPipeline = require('./pipelines/ForwardDiffuseLightPipeline'); +/** + * @namespace Phaser.Renderer.WebGLRenderer + */ + var WebGLRenderer = new Class({ initialize: diff --git a/src/scene/index.js b/src/scene/index.js index bed3f3f10..c239e8e3f 100644 --- a/src/scene/index.js +++ b/src/scene/index.js @@ -1,4 +1,6 @@ -// Phaser.Scenes +/** + * @namespace Phaser.Scenes + */ module.exports = { diff --git a/src/sound/index.js b/src/sound/index.js index f15f79577..c31d70596 100644 --- a/src/sound/index.js +++ b/src/sound/index.js @@ -1,4 +1,6 @@ -// Phaser.Sound +/** + * @namespace Phaser.Sound + */ module.exports = { diff --git a/src/structs/index.js b/src/structs/index.js index 8ecd4f1db..460b2ac80 100644 --- a/src/structs/index.js +++ b/src/structs/index.js @@ -1,4 +1,6 @@ -// Phaser.Structs +/** + * @namespace Phaser.Structs + */ module.exports = { diff --git a/src/textures/index.js b/src/textures/index.js index 1861bafb1..b5b98b760 100644 --- a/src/textures/index.js +++ b/src/textures/index.js @@ -1,4 +1,6 @@ -// Phaser.Textures +/** + * @namespace Phaser.Textures + */ module.exports = { diff --git a/src/time/index.js b/src/time/index.js index 5a8246bf0..1d212271d 100644 --- a/src/time/index.js +++ b/src/time/index.js @@ -1,4 +1,6 @@ -// Phaser.Time +/** + * @namespace Phaser.Time + */ module.exports = { diff --git a/src/tweens/index.js b/src/tweens/index.js index 554a4f6f5..11b29cb03 100644 --- a/src/tweens/index.js +++ b/src/tweens/index.js @@ -1,4 +1,6 @@ -// Phaser.Tweens +/** + * @namespace Phaser.Tweens + */ module.exports = { diff --git a/src/utils/index.js b/src/utils/index.js index 4e3117fc1..ca4f896f4 100644 --- a/src/utils/index.js +++ b/src/utils/index.js @@ -1,4 +1,6 @@ -// Phaser.Utils +/** + * @namespace Phaser.Utils + */ module.exports = {