Improved Math.Angle function documentation.

This commit is contained in:
Chris Andrew 2018-05-24 13:14:04 +01:00
parent 1c94c3d4d6
commit 313ae38bb1
5 changed files with 11 additions and 9 deletions

View file

@ -5,9 +5,7 @@
*/ */
/** /**
* Calculate the angle between two sets of coordinates (points). * Find the angle of a segment from (x1, y1) -> (x2, y2).
*
* Calculates the angle of the vector from the first point to the second point.
* *
* @function Phaser.Math.Angle.Between * @function Phaser.Math.Angle.Between
* @since 3.0.0 * @since 3.0.0

View file

@ -5,7 +5,7 @@
*/ */
/** /**
* Calculate the angle between two points. * Find the angle of a segment from (point1.x, point1.y) -> (point2.x, point2.y).
* *
* Calculates the angle of the vector from the first point to the second point. * Calculates the angle of the vector from the first point to the second point.
* *

View file

@ -5,7 +5,10 @@
*/ */
/** /**
* [description] * Find the angle of a segment from (point1.x, point1.y) -> (point2.x, point2.y).
*
* The difference between this method and {@link Phaser.Math.Angle.BetweenPoints} is that this assumes the y coordinate
* travels down the screen.
* *
* @function Phaser.Math.Angle.BetweenPointsY * @function Phaser.Math.Angle.BetweenPointsY
* @since 3.0.0 * @since 3.0.0

View file

@ -5,7 +5,10 @@
*/ */
/** /**
* [description] * Find the angle of a segment from (x1, y1) -> (x2, y2).
*
* The difference between this method and {@link Phaser.Math.Angle.Between} is that this assumes the y coordinate
* travels down the screen.
* *
* @function Phaser.Math.Angle.BetweenY * @function Phaser.Math.Angle.BetweenY
* @since 3.0.0 * @since 3.0.0

View file

@ -5,9 +5,7 @@
*/ */
/** /**
* Normalize the given angle. * Normalize an angle to the [0, 2pi] range.
*
* [description] TODO: Needs elaborating
* *
* @function Phaser.Math.Angle.Normalize * @function Phaser.Math.Angle.Normalize
* @since 3.0.0 * @since 3.0.0