JSDocs update ;)

This commit is contained in:
Webeled
2013-09-19 16:34:48 +02:00
parent 78a062dfb6
commit 26a595cd44
8 changed files with 261 additions and 57 deletions
+8 -8
View File
@@ -117,8 +117,8 @@ Phaser.Camera.prototype = {
/**
* Tells this camera which sprite to follow.
* @method follow
* @param target {Phaser.Sprite} The object you want the camera to track. Set to null to not follow anything.
* @param [style] {number} Leverage one of the existing "deadzone" presets. If you use a custom deadzone, ignore this parameter and manually specify the deadzone after calling follow().
* @param {Phaser.Sprite} target The object you want the camera to track. Set to null to not follow anything.
* @param {number} [style] Leverage one of the existing "deadzone" presets. If you use a custom deadzone, ignore this parameter and manually specify the deadzone after calling follow().
*/
follow: function (target, style) {
@@ -157,8 +157,8 @@ Phaser.Camera.prototype = {
/**
* Move the camera focus to a location instantly.
* @method focusOnXY
* @param x {number} X position.
* @param y {number} Y position.
* @param {number} x X position.
* @param {number} y Y position.
*/
focusOnXY: function (x, y) {
@@ -260,8 +260,8 @@ Phaser.Camera.prototype = {
* without having to use game.camera.x and game.camera.y
*
* @method setPosition
* @param x {number} X position.
* @param y {number} Y position.
* @param {number} x X position.
* @param {number} y Y position.
*/
setPosition: function (x, y) {
@@ -275,8 +275,8 @@ Phaser.Camera.prototype = {
* Sets the size of the view rectangle given the width and height in parameters
*
* @method setSize
* @param width {number} the desired width.
* @param height {number} the desired height.
* @param {number} width The desired width.
* @param {number} height The desired height.
*/
setSize: function (width, height) {
+5 -5
View File
@@ -12,9 +12,9 @@
*
* @class Stage
* @constructor
* @param game {Phaser.Game} game reference to the currently running game.
* @param width {number} width of the canvas element
* @param height {number} height of the canvas element
* @param {Phaser.Game} game Game reference to the currently running game.
* @param {number} width Width of the canvas element
* @param {number} height Height of the canvas element
*/
Phaser.Stage = function (game, width, height) {
@@ -64,7 +64,7 @@ Phaser.Stage = function (game, width, height) {
* The current scaleMode
* @property scaleMode
* @public
* @type {Phaser.StageScaleMode}
* @type {number}
*/
this.scaleMode = Phaser.StageScaleMode.NO_SCALE;
@@ -117,7 +117,7 @@ Phaser.Stage.prototype = {
/**
* This method is called when the document visibility is changed.
* @method visibilityChange
* @param event [Event] its type will be used to decide whether the game should be paused or not
* @param {Event} event Its type will be used to decide whether the game should be paused or not
*/
visibilityChange: function (event) {
+3 -3
View File
@@ -15,7 +15,7 @@
*
* @class World
* @constructor
* @param game {Phaser.Game} reference to the current game instance.
* @param {Phaser.Game} game Reference to the current game instance.
*/
Phaser.World = function (game) {
@@ -115,8 +115,8 @@ Phaser.World.prototype = {
/**
* Updates the size of this world.
* @method setSize
* @param width {number} New width of the world.
* @param height {number} New height of the world.
* @param {number} width New width of the world.
* @param {number} height New height of the world.
*/
setSize: function (width, height) {