Lots of doc fixes (thanks nhowell)

This commit is contained in:
photonstorm
2014-02-20 03:44:44 +00:00
parent 4ad7b304c6
commit 9fcab5ef26
6 changed files with 8 additions and 10 deletions
+3 -3
View File
@@ -129,7 +129,7 @@ Phaser.BitmapText.prototype = Object.create(PIXI.BitmapText.prototype);
Phaser.BitmapText.prototype.constructor = Phaser.BitmapText;
/**
* @method setStyle
* @method Phaser.BitmapText.prototype.setStyle
* @private
*/
Phaser.BitmapText.prototype.setStyle = function() {
@@ -177,8 +177,7 @@ Phaser.BitmapText.prototype.preUpdate = function () {
/**
* Override and use this function in your own custom objects to handle any update requirements you may have.
*
* @method Phaser.BitmapText#update
* @memberof Phaser.BitmapText
* @method Phaser.BitmapText.prototype.update
*/
Phaser.BitmapText.prototype.update = function() {
@@ -200,6 +199,7 @@ Phaser.BitmapText.prototype.postUpdate = function () {
}
/**
* Destroy this BitmapText instance. This will remove any filters and un-parent any children.
* @method Phaser.BitmapText.prototype.destroy
*/
Phaser.BitmapText.prototype.destroy = function() {
+2 -2
View File
@@ -137,7 +137,7 @@ Phaser.Graphics.prototype.postUpdate = function () {
/**
* Destroy this Graphics instance.
*
* @method Phaser.Sprite.prototype.destroy
* @method Phaser.Graphics.prototype.destroy
*/
Phaser.Graphics.prototype.destroy = function() {
@@ -158,7 +158,7 @@ Phaser.Graphics.prototype.destroy = function() {
/*
* Draws a {Phaser.Polygon} or a {PIXI.Polygon} filled
*
* @method Phaser.Sprite.prototype.drawPolygon
* @method Phaser.Graphics.prototype.drawPolygon
*/
Phaser.Graphics.prototype.drawPolygon = function (poly) {
-1
View File
@@ -916,7 +916,6 @@ Object.defineProperty(Phaser.Sprite.prototype, "exists", {
});
/**
* An Sprite that is fixed to the camera uses its x/y coordinates as offsets from the top left of the camera. These are stored in Sprite.cameraOffset.
* Note that the cameraOffset values are in addition to any parent in the display list.
+1 -1
View File
@@ -186,7 +186,7 @@ Object.defineProperty(Phaser.Line.prototype, "perpSlope", {
* Returns the intersection segment of AB and EF as a Point, or null if there is no intersection.
* Adapted from code by Keith Hair
*
* @method Phaser.Line.intersects
* @method Phaser.Line.intersectsPoints
* @param {Phaser.Point} a - The start of the first Line to be checked.
* @param {Phaser.Point} b - The end of the first line to be checked.
* @param {Phaser.Point} e - The start of the second Line to be checked.
+1 -2
View File
@@ -32,7 +32,7 @@ Phaser.Math = {
/**
* a is fuzzyLessThan b if it is less than b + ε.
* @method Phaser.Math#fuzzyEqual
* @method Phaser.Math#fuzzyLessThan
* @param {number} a
* @param {number} b
* @param {number} epsilon
@@ -810,7 +810,6 @@ Phaser.Math = {
* @param {number} angle - The angle value to check. Must be between -180 and +180.
* @param {number} min - The minimum angle that is allowed (must be -180 or greater).
* @param {number} max - The maximum angle that is allowed (must be 180 or less).
*
* @return {number} The new angle value, returns the same as the input angle if it was within bounds
*/
angleLimit: function (angle, min, max) {
+1 -1
View File
@@ -174,7 +174,7 @@ Phaser.TweenManager.prototype = {
/**
* Pauses all currently running tweens.
*
* @method Phaser.TweenManager#update
* @method Phaser.TweenManager#pauseAll
*/
pauseAll: function () {