Finished Geom JSDocs

photonstorm · photonstorm · commit 0ee6d16c17e7 · 2020-02-04T16:19:42.000Z
diff --git a/src/geom/line/NormalX.js b/src/geom/line/NormalX.js
@@ -8,14 +8,14 @@ var MATH_CONST = require('../../math/const');
 var Angle = require('./Angle');
 
 /**
- * [description]
+ * Returns the x component of the normal vector of the given line.
  *
  * @function Phaser.Geom.Line.NormalX
  * @since 3.0.0
  *
  * @param {Phaser.Geom.Line} line - The Line object to get the normal value from.
  *
- * @return {number} [description]
+ * @return {number} The x component of the normal vector of the line.
  */
 var NormalX = function (line)
 {
diff --git a/src/geom/point/GetCentroid.js b/src/geom/point/GetCentroid.js
@@ -15,10 +15,10 @@ var Point = require('./Point');
  *
  * @generic {Phaser.Geom.Point} O - [out,$return]
  *
- * @param {Phaser.Geom.Point[]} points - [description]
- * @param {Phaser.Geom.Point} [out] - [description]
+ * @param {Phaser.Types.Math.Vector2Like[]} points - An array of Vector2Like objects to get the geometric center of.
+ * @param {Phaser.Geom.Point} [out] - A Point object to store the output coordinates in. If not given, a new Point instance is created.
  *
- * @return {Phaser.Geom.Point} [description]
+ * @return {Phaser.Geom.Point} A Point object representing the geometric center of the given points.
  */
 var GetCentroid = function (points, out)
 {
diff --git a/src/geom/point/GetRectangleFromPoints.js b/src/geom/point/GetRectangleFromPoints.js
@@ -14,10 +14,10 @@ var Rectangle = require('../rectangle/Rectangle');
  *
  * @generic {Phaser.Geom.Rectangle} O - [out,$return]
  *
- * @param {Phaser.Geom.Point[]} points - [description]
- * @param {Phaser.Geom.Rectangle} [out] - [description]
+ * @param {Phaser.Types.Math.Vector2Like[]} points - An array of Vector2Like objects to get the AABB from.
+ * @param {Phaser.Geom.Rectangle} [out] - A Rectangle object to store the results in. If not given, a new Rectangle instance is created.
  *
- * @return {Phaser.Geom.Rectangle} [description]
+ * @return {Phaser.Geom.Rectangle} A Rectangle object holding the AABB values for the given points.
  */
 var GetRectangleFromPoints = function (points, out)
 {
diff --git a/src/geom/point/Interpolate.js b/src/geom/point/Interpolate.js
@@ -7,7 +7,7 @@
 var Point = require('./Point');
 
 /**
- * [description]
+ * Returns the linear interpolation point between the two given points, based on `t`.
  *
  * @function Phaser.Geom.Point.Interpolate
  * @since 3.0.0
diff --git a/src/geom/point/Project.js b/src/geom/point/Project.js
@@ -8,18 +8,19 @@ var Point = require('./Point');
 var GetMagnitudeSq = require('./GetMagnitudeSq');
 
 /**
- * [description]
+ * Calculates the vector projection of `pointA` onto the nonzero `pointB`. This is the
+ * orthogonal projection of `pointA` onto a straight line paralle to `pointB`.
  *
  * @function Phaser.Geom.Point.Project
  * @since 3.0.0
  *
  * @generic {Phaser.Geom.Point} O - [out,$return]
  *
- * @param {Phaser.Geom.Point} pointA - [description]
- * @param {Phaser.Geom.Point} pointB - [description]
- * @param {Phaser.Geom.Point} [out] - [description]
+ * @param {Phaser.Geom.Point} pointA - Point A, to be projected onto Point B.
+ * @param {Phaser.Geom.Point} pointB - Point B, to have Point A projected upon it.
+ * @param {Phaser.Geom.Point} [out] - The Point object to store the position in. If not given, a new Point instance is created.
  *
- * @return {Phaser.Geom.Point} [description]
+ * @return {Phaser.Geom.Point} A Point object holding the coordinates of the vector projection of `pointA` onto `pointB`.
  */
 var Project = function (pointA, pointB, out)
 {
diff --git a/src/geom/point/ProjectUnit.js b/src/geom/point/ProjectUnit.js
@@ -7,18 +7,19 @@
 var Point = require('./Point');
 
 /**
- * [description]
+ * Calculates the vector projection of `pointA` onto the nonzero `pointB`. This is the
+ * orthogonal projection of `pointA` onto a straight line paralle to `pointB`.
  *
  * @function Phaser.Geom.Point.ProjectUnit
  * @since 3.0.0
  *
  * @generic {Phaser.Geom.Point} O - [out,$return]
  *
- * @param {Phaser.Geom.Point} pointA - [description]
- * @param {Phaser.Geom.Point} pointB - [description]
- * @param {Phaser.Geom.Point} [out] - [description]
+ * @param {Phaser.Geom.Point} pointA - Point A, to be projected onto Point B. Must be a normalized point with a magnitude of 1.
+ * @param {Phaser.Geom.Point} pointB - Point B, to have Point A projected upon it.
+ * @param {Phaser.Geom.Point} [out] - The Point object to store the position in. If not given, a new Point instance is created.
  *
- * @return {Phaser.Geom.Point} [description]
+ * @return {Phaser.Geom.Point} A unit Point object holding the coordinates of the vector projection of `pointA` onto `pointB`.
  */
 var ProjectUnit = function (pointA, pointB, out)
 {
diff --git a/src/geom/polygon/ContainsPoint.js b/src/geom/polygon/ContainsPoint.js
@@ -7,15 +7,15 @@
 var Contains = require('./Contains');
 
 /**
- * [description]
+ * Checks the given Point again the Polygon to see if the Point lays within its vertices.
  *
  * @function Phaser.Geom.Polygon.ContainsPoint
  * @since 3.0.0
  *
- * @param {Phaser.Geom.Polygon} polygon - [description]
- * @param {Phaser.Geom.Point} point - [description]
+ * @param {Phaser.Geom.Polygon} polygon - The Polygon to check.
+ * @param {Phaser.Geom.Point} point - The Point to check if it's within the Polygon.
  *
- * @return {boolean} [description]
+ * @return {boolean} `true` if the Point is within the Polygon, otherwise `false`.
  */
 var ContainsPoint = function (polygon, point)
 {
diff --git a/src/geom/rectangle/GetPoint.js b/src/geom/rectangle/GetPoint.js
@@ -8,18 +8,22 @@ var Perimeter = require('./Perimeter');
 var Point = require('../point/Point');
 
 /**
- * Position is a value between 0 and 1 where 0 = the top-left of the rectangle and 0.5 = the bottom right.
+ * Calculates the coordinates of a point at a certain `position` on the Rectangle's perimeter.
+ * 
+ * The `position` is a fraction between 0 and 1 which defines how far into the perimeter the point is.
+ * 
+ * A value of 0 or 1 returns the point at the top left corner of the rectangle, while a value of 0.5 returns the point at the bottom right corner of the rectangle. Values between 0 and 0.5 are on the top or the right side and values between 0.5 and 1 are on the bottom or the left side.
  *
  * @function Phaser.Geom.Rectangle.GetPoint
  * @since 3.0.0
  *
  * @generic {Phaser.Geom.Point} O - [out,$return]
  *
- * @param {Phaser.Geom.Rectangle} rectangle - [description]
- * @param {number} position - [description]
- * @param {(Phaser.Geom.Point|object)} [out] - [description]
+ * @param {Phaser.Geom.Rectangle} rectangle - The Rectangle to get the perimeter point from.
+ * @param {number} position - The normalized distance into the Rectangle's perimeter to return.
+ * @param {(Phaser.Geom.Point|object)} [out] - An object to update with the `x` and `y` coordinates of the point.
  *
- * @return {Phaser.Geom.Point} [description]
+ * @return {Phaser.Geom.Point} The updated `output` object, or a new Point if no `output` object was given.
  */
 var GetPoint = function (rectangle, position, out)
 {
diff --git a/src/geom/rectangle/GetSize.js b/src/geom/rectangle/GetSize.js
@@ -8,18 +8,18 @@ var Point = require('../point/Point');
 
 
 /**
- *  The size of the Rectangle object, expressed as a Point object
- *  with the values of the width and height properties.
+ * Returns the size of the Rectangle, expressed as a Point object.
+ * With the value of the `width` as the `x` property and the `height` as the `y` property.
  *
  * @function Phaser.Geom.Rectangle.GetSize
  * @since 3.0.0
  *
  * @generic {Phaser.Geom.Point} O - [out,$return]
  *
- * @param {Phaser.Geom.Rectangle} rect - [description]
- * @param {(Phaser.Geom.Point|object)} [out] - [description]
+ * @param {Phaser.Geom.Rectangle} rect - The Rectangle to get the size from.
+ * @param {(Phaser.Geom.Point|object)} [out] - The Point object to store the size in. If not given, a new Point instance is created.
  *
- * @return {(Phaser.Geom.Point|object)} [description]
+ * @return {(Phaser.Geom.Point|object)} A Point object where `x` holds the width and `y` holds the height of the Rectangle.
  */
 var GetSize = function (rect, out)
 {
diff --git a/src/geom/rectangle/MarchingAnts.js b/src/geom/rectangle/MarchingAnts.js
@@ -9,20 +9,20 @@ var Point = require('../point/Point');
 
 
 /**
- *  Return an array of points from the perimeter of the rectangle
- *  each spaced out based on the quantity or step required
+ * Returns an array of points from the perimeter of the Rectangle, where each point is spaced out based
+ * on either the `step` value, or the `quantity`.
  *
  * @function Phaser.Geom.Rectangle.MarchingAnts
  * @since 3.0.0
  *
  * @generic {Phaser.Geom.Point[]} O - [out,$return]
  *
- * @param {Phaser.Geom.Rectangle} rect - [description]
- * @param {number} step - [description]
- * @param {integer} quantity - [description]
- * @param {(array|Phaser.Geom.Point[])} [out] - [description]
+ * @param {Phaser.Geom.Rectangle} rect - The Rectangle to get the perimeter points from.
+ * @param {number} [step] - The distance between each point of the perimeter. Set to `null` if you wish to use the `quantity` parameter instead.
+ * @param {integer} [quantity] - The total number of points to return. The step is then calculated based on the length of the Rectangle, divided by this value.
+ * @param {(array|Phaser.Geom.Point[])} [out] - An array in which the perimeter points will be stored. If not given, a new array instance is created.
  *
- * @return {(array|Phaser.Geom.Point[])} [description]
+ * @return {(array|Phaser.Geom.Point[])} An array containing the perimeter points from the Rectangle.
  */
 var MarchingAnts = function (rect, step, quantity, out)
 {
diff --git a/src/geom/rectangle/PerimeterPoint.js b/src/geom/rectangle/PerimeterPoint.js
@@ -8,18 +8,18 @@ var Point = require('../point/Point');
 var DegToRad = require('../../math/DegToRad');
 
 /**
- * [description]
+ * Returns a Point from the perimeter of a Rectangle based on the given angle.
  *
  * @function Phaser.Geom.Rectangle.PerimeterPoint
  * @since 3.0.0
  *
  * @generic {Phaser.Geom.Point} O - [out,$return]
  *
- * @param {Phaser.Geom.Rectangle} rectangle - [description]
- * @param {integer} angle - [description]
- * @param {Phaser.Geom.Point} [out] - [description]
+ * @param {Phaser.Geom.Rectangle} rectangle - The Rectangle to get the perimeter point from.
+ * @param {integer} angle - The angle of the point, in degrees.
+ * @param {Phaser.Geom.Point} [out] - The Point object to store the position in. If not given, a new Point instance is created.
  *
- * @return {Phaser.Geom.Point} [description]
+ * @return {Phaser.Geom.Point} A Point object holding the coordinates of the Rectangle perimeter.
  */
 var PerimeterPoint = function (rectangle, angle, out)
 {
diff --git a/src/geom/triangle/BuildFromPolygon.js b/src/geom/triangle/BuildFromPolygon.js
@@ -8,7 +8,8 @@ var EarCut = require('../polygon/Earcut');
 var Triangle = require('./Triangle');
 
 /**
- * [description]
+ * Takes an array of vertex coordinates, and optionally an array of hole indices, then returns an array
+ * of Triangle instances, where the given vertices have been decomposed into a series of triangles.
  *
  * @function Phaser.Geom.Triangle.BuildFromPolygon
  * @since 3.0.0
@@ -17,11 +18,11 @@ var Triangle = require('./Triangle');
  *
  * @param {array} data - A flat array of vertex coordinates like [x0,y0, x1,y1, x2,y2, ...]
  * @param {array} [holes=null] - An array of hole indices if any (e.g. [5, 8] for a 12-vertex input would mean one hole with vertices 5–7 and another with 8–11).
- * @param {number} [scaleX=1] - [description]
- * @param {number} [scaleY=1] - [description]
- * @param {(array|Phaser.Geom.Triangle[])} [out] - [description]
+ * @param {number} [scaleX=1] - Horizontal scale factor to multiply the resulting points by.
+ * @param {number} [scaleY=1] - Vertical scale factor to multiply the resulting points by.
+ * @param {(array|Phaser.Geom.Triangle[])} [out] - An array to store the resulting Triangle instances in. If not provided, a new array is created.
  *
- * @return {(array|Phaser.Geom.Triangle[])} [description]
+ * @return {(array|Phaser.Geom.Triangle[])} An array of Triangle instances, where each triangle is based on the decomposed vertices data.
  */
 var BuildFromPolygon = function (data, holes, scaleX, scaleY, out)
 {
diff --git a/src/geom/triangle/CircumCenter.js b/src/geom/triangle/CircumCenter.js
@@ -39,10 +39,10 @@ function det (m00, m01, m10, m11)
  *
  * @generic {Phaser.Math.Vector2} O - [out,$return]
  *
- * @param {Phaser.Geom.Triangle} triangle - [description]
- * @param {Phaser.Math.Vector2} [out] - [description]
+ * @param {Phaser.Geom.Triangle} triangle - The Triangle to get the circumcenter of.
+ * @param {Phaser.Math.Vector2} [out] - The Vector2 object to store the position in. If not given, a new Vector2 instance is created.
  *
- * @return {Phaser.Math.Vector2} [description]
+ * @return {Phaser.Math.Vector2} A Vector2 object holding the coordinates of the circumcenter of the Triangle.
  */
 var CircumCenter = function (triangle, out)
 {
diff --git a/src/geom/triangle/Perimeter.js b/src/geom/triangle/Perimeter.js
@@ -6,17 +6,16 @@
 
 var Length = require('../line/Length');
 
-// The 2D area of a triangle. The area value is always non-negative.
-
 /**
  * Gets the length of the perimeter of the given triangle.
+ * Calculated by adding together the length of each of the three sides.
  *
  * @function Phaser.Geom.Triangle.Perimeter
  * @since 3.0.0
  *
- * @param {Phaser.Geom.Triangle} triangle - [description]
+ * @param {Phaser.Geom.Triangle} triangle - The Triangle to get the length from.
  *
- * @return {number} [description]
+ * @return {number} The length of the Triangle.
  */
 var Perimeter = function (triangle)
 {
diff --git a/src/geom/triangle/Random.js b/src/geom/triangle/Random.js
@@ -7,17 +7,17 @@
 var Point = require('../point/Point');
 
 /**
- * [description]
+ * Returns a random Point from within the area of the given Triangle.
  *
  * @function Phaser.Geom.Triangle.Random
  * @since 3.0.0
  *
  * @generic {Phaser.Geom.Point} O - [out,$return]
  *
- * @param {Phaser.Geom.Triangle} triangle - [description]
- * @param {Phaser.Geom.Point} [out] - [description]
+ * @param {Phaser.Geom.Triangle} triangle - The Triangle to get a random point from.
+ * @param {Phaser.Geom.Point} [out] - The Point object to store the position in. If not given, a new Point instance is created.
  *
- * @return {Phaser.Geom.Point} [description]
+ * @return {Phaser.Geom.Point} A Point object holding the coordinates of a random position within the Triangle.
  */
 var Random = function (triangle, out)
 {

Original file line number	Diff line number	Diff line change
`@@ -8,14 +8,14 @@ var MATH_CONST = require('../../math/const');`
`8`	`8`	`var Angle = require('./Angle');`
`9`	`9`
`10`	`10`	`/**`
`11`		`- * [description]`
	`11`	`+ * Returns the x component of the normal vector of the given line.`
`12`	`12`	`*`
`13`	`13`	`* @function Phaser.Geom.Line.NormalX`
`14`	`14`	`* @since 3.0.0`
`15`	`15`	`*`
`16`	`16`	`* @param {Phaser.Geom.Line} line - The Line object to get the normal value from.`
`17`	`17`	`*`
`18`		`- * @return {number} [description]`
	`18`	`+ * @return {number} The x component of the normal vector of the line.`
`19`	`19`	`*/`
`20`	`20`	`var NormalX = function (line)`
`21`	`21`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,10 +15,10 @@ var Point = require('./Point');`
`15`	`15`	`*`
`16`	`16`	`* @generic {Phaser.Geom.Point} O - [out,$return]`
`17`	`17`	`*`
`18`		`- * @param {Phaser.Geom.Point[]} points - [description]`
`19`		`- * @param {Phaser.Geom.Point} [out] - [description]`
	`18`	`+ * @param {Phaser.Types.Math.Vector2Like[]} points - An array of Vector2Like objects to get the geometric center of.`
	`19`	`+ * @param {Phaser.Geom.Point} [out] - A Point object to store the output coordinates in. If not given, a new Point instance is created.`
`20`	`20`	`*`
`21`		`- * @return {Phaser.Geom.Point} [description]`
	`21`	`+ * @return {Phaser.Geom.Point} A Point object representing the geometric center of the given points.`
`22`	`22`	`*/`
`23`	`23`	`var GetCentroid = function (points, out)`
`24`	`24`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,10 +14,10 @@ var Rectangle = require('../rectangle/Rectangle');`
`14`	`14`	`*`
`15`	`15`	`* @generic {Phaser.Geom.Rectangle} O - [out,$return]`
`16`	`16`	`*`
`17`		`- * @param {Phaser.Geom.Point[]} points - [description]`
`18`		`- * @param {Phaser.Geom.Rectangle} [out] - [description]`
	`17`	`+ * @param {Phaser.Types.Math.Vector2Like[]} points - An array of Vector2Like objects to get the AABB from.`
	`18`	`+ * @param {Phaser.Geom.Rectangle} [out] - A Rectangle object to store the results in. If not given, a new Rectangle instance is created.`
`19`	`19`	`*`
`20`		`- * @return {Phaser.Geom.Rectangle} [description]`
	`20`	`+ * @return {Phaser.Geom.Rectangle} A Rectangle object holding the AABB values for the given points.`
`21`	`21`	`*/`
`22`	`22`	`var GetRectangleFromPoints = function (points, out)`
`23`	`23`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`var Point = require('./Point');`
`8`	`8`
`9`	`9`	`/**`
`10`		`- * [description]`
	`10`	+ * Returns the linear interpolation point between the two given points, based on `t`.
`11`	`11`	`*`
`12`	`12`	`* @function Phaser.Geom.Point.Interpolate`
`13`	`13`	`* @since 3.0.0`
Original file line number	Diff line number	Diff line change
`@@ -8,18 +8,19 @@ var Point = require('./Point');`
`8`	`8`	`var GetMagnitudeSq = require('./GetMagnitudeSq');`
`9`	`9`
`10`	`10`	`/**`
`11`		`- * [description]`
	`11`	+ * Calculates the vector projection of `pointA` onto the nonzero `pointB`. This is the
	`12`	+ * orthogonal projection of `pointA` onto a straight line paralle to `pointB`.
`12`	`13`	`*`
`13`	`14`	`* @function Phaser.Geom.Point.Project`
`14`	`15`	`* @since 3.0.0`
`15`	`16`	`*`
`16`	`17`	`* @generic {Phaser.Geom.Point} O - [out,$return]`
`17`	`18`	`*`
`18`		`- * @param {Phaser.Geom.Point} pointA - [description]`
`19`		`- * @param {Phaser.Geom.Point} pointB - [description]`
`20`		`- * @param {Phaser.Geom.Point} [out] - [description]`
	`19`	`+ * @param {Phaser.Geom.Point} pointA - Point A, to be projected onto Point B.`
	`20`	`+ * @param {Phaser.Geom.Point} pointB - Point B, to have Point A projected upon it.`
	`21`	`+ * @param {Phaser.Geom.Point} [out] - The Point object to store the position in. If not given, a new Point instance is created.`
`21`	`22`	`*`
`22`		`- * @return {Phaser.Geom.Point} [description]`
	`23`	+ * @return {Phaser.Geom.Point} A Point object holding the coordinates of the vector projection of `pointA` onto `pointB`.
`23`	`24`	`*/`
`24`	`25`	`var Project = function (pointA, pointB, out)`
`25`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,18 +7,19 @@`
`7`	`7`	`var Point = require('./Point');`
`8`	`8`
`9`	`9`	`/**`
`10`		`- * [description]`
	`10`	+ * Calculates the vector projection of `pointA` onto the nonzero `pointB`. This is the
	`11`	+ * orthogonal projection of `pointA` onto a straight line paralle to `pointB`.
`11`	`12`	`*`
`12`	`13`	`* @function Phaser.Geom.Point.ProjectUnit`
`13`	`14`	`* @since 3.0.0`
`14`	`15`	`*`
`15`	`16`	`* @generic {Phaser.Geom.Point} O - [out,$return]`
`16`	`17`	`*`
`17`		`- * @param {Phaser.Geom.Point} pointA - [description]`
`18`		`- * @param {Phaser.Geom.Point} pointB - [description]`
`19`		`- * @param {Phaser.Geom.Point} [out] - [description]`
	`18`	`+ * @param {Phaser.Geom.Point} pointA - Point A, to be projected onto Point B. Must be a normalized point with a magnitude of 1.`
	`19`	`+ * @param {Phaser.Geom.Point} pointB - Point B, to have Point A projected upon it.`
	`20`	`+ * @param {Phaser.Geom.Point} [out] - The Point object to store the position in. If not given, a new Point instance is created.`
`20`	`21`	`*`
`21`		`- * @return {Phaser.Geom.Point} [description]`
	`22`	+ * @return {Phaser.Geom.Point} A unit Point object holding the coordinates of the vector projection of `pointA` onto `pointB`.
`22`	`23`	`*/`
`23`	`24`	`var ProjectUnit = function (pointA, pointB, out)`
`24`	`25`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,15 +7,15 @@`
`7`	`7`	`var Contains = require('./Contains');`
`8`	`8`
`9`	`9`	`/**`
`10`		`- * [description]`
	`10`	`+ * Checks the given Point again the Polygon to see if the Point lays within its vertices.`
`11`	`11`	`*`
`12`	`12`	`* @function Phaser.Geom.Polygon.ContainsPoint`
`13`	`13`	`* @since 3.0.0`
`14`	`14`	`*`
`15`		`- * @param {Phaser.Geom.Polygon} polygon - [description]`
`16`		`- * @param {Phaser.Geom.Point} point - [description]`
	`15`	`+ * @param {Phaser.Geom.Polygon} polygon - The Polygon to check.`
	`16`	`+ * @param {Phaser.Geom.Point} point - The Point to check if it's within the Polygon.`
`17`	`17`	`*`
`18`		`- * @return {boolean} [description]`
	`18`	+ * @return {boolean} `true` if the Point is within the Polygon, otherwise `false`.
`19`	`19`	`*/`
`20`	`20`	`var ContainsPoint = function (polygon, point)`
`21`	`21`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,18 +8,22 @@ var Perimeter = require('./Perimeter');`
`8`	`8`	`var Point = require('../point/Point');`
`9`	`9`
`10`	`10`	`/**`
`11`		`- * Position is a value between 0 and 1 where 0 = the top-left of the rectangle and 0.5 = the bottom right.`
	`11`	+ * Calculates the coordinates of a point at a certain `position` on the Rectangle's perimeter.
	`12`	`+ *`
	`13`	+ * The `position` is a fraction between 0 and 1 which defines how far into the perimeter the point is.
	`14`	`+ *`
	`15`	`+ * A value of 0 or 1 returns the point at the top left corner of the rectangle, while a value of 0.5 returns the point at the bottom right corner of the rectangle. Values between 0 and 0.5 are on the top or the right side and values between 0.5 and 1 are on the bottom or the left side.`
`12`	`16`	`*`
`13`	`17`	`* @function Phaser.Geom.Rectangle.GetPoint`
`14`	`18`	`* @since 3.0.0`
`15`	`19`	`*`
`16`	`20`	`* @generic {Phaser.Geom.Point} O - [out,$return]`
`17`	`21`	`*`
`18`		`- * @param {Phaser.Geom.Rectangle} rectangle - [description]`
`19`		`- * @param {number} position - [description]`
`20`		`- * @param {(Phaser.Geom.Point\|object)} [out] - [description]`
	`22`	`+ * @param {Phaser.Geom.Rectangle} rectangle - The Rectangle to get the perimeter point from.`
	`23`	`+ * @param {number} position - The normalized distance into the Rectangle's perimeter to return.`
	`24`	+ * @param {(Phaser.Geom.Point\|object)} [out] - An object to update with the `x` and `y` coordinates of the point.
`21`	`25`	`*`
`22`		`- * @return {Phaser.Geom.Point} [description]`
	`26`	+ * @return {Phaser.Geom.Point} The updated `output` object, or a new Point if no `output` object was given.
`23`	`27`	`*/`
`24`	`28`	`var GetPoint = function (rectangle, position, out)`
`25`	`29`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,18 +8,18 @@ var Point = require('../point/Point');`
`8`	`8`
`9`	`9`
`10`	`10`	`/**`
`11`		`- * The size of the Rectangle object, expressed as a Point object`
`12`		`- * with the values of the width and height properties.`
	`11`	`+ * Returns the size of the Rectangle, expressed as a Point object.`
	`12`	+ * With the value of the `width` as the `x` property and the `height` as the `y` property.
`13`	`13`	`*`
`14`	`14`	`* @function Phaser.Geom.Rectangle.GetSize`
`15`	`15`	`* @since 3.0.0`
`16`	`16`	`*`
`17`	`17`	`* @generic {Phaser.Geom.Point} O - [out,$return]`
`18`	`18`	`*`
`19`		`- * @param {Phaser.Geom.Rectangle} rect - [description]`
`20`		`- * @param {(Phaser.Geom.Point\|object)} [out] - [description]`
	`19`	`+ * @param {Phaser.Geom.Rectangle} rect - The Rectangle to get the size from.`
	`20`	`+ * @param {(Phaser.Geom.Point\|object)} [out] - The Point object to store the size in. If not given, a new Point instance is created.`
`21`	`21`	`*`
`22`		`- * @return {(Phaser.Geom.Point\|object)} [description]`
	`22`	+ * @return {(Phaser.Geom.Point\|object)} A Point object where `x` holds the width and `y` holds the height of the Rectangle.
`23`	`23`	`*/`
`24`	`24`	`var GetSize = function (rect, out)`
`25`	`25`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,20 +9,20 @@ var Point = require('../point/Point');`
`9`	`9`
`10`	`10`
`11`	`11`	`/**`
`12`		`- * Return an array of points from the perimeter of the rectangle`
`13`		`- * each spaced out based on the quantity or step required`
	`12`	`+ * Returns an array of points from the perimeter of the Rectangle, where each point is spaced out based`
	`13`	+ * on either the `step` value, or the `quantity`.
`14`	`14`	`*`
`15`	`15`	`* @function Phaser.Geom.Rectangle.MarchingAnts`
`16`	`16`	`* @since 3.0.0`
`17`	`17`	`*`
`18`	`18`	`* @generic {Phaser.Geom.Point[]} O - [out,$return]`
`19`	`19`	`*`
`20`		`- * @param {Phaser.Geom.Rectangle} rect - [description]`
`21`		`- * @param {number} step - [description]`
`22`		`- * @param {integer} quantity - [description]`
`23`		`- * @param {(array\|Phaser.Geom.Point[])} [out] - [description]`
	`20`	`+ * @param {Phaser.Geom.Rectangle} rect - The Rectangle to get the perimeter points from.`
	`21`	+ * @param {number} [step] - The distance between each point of the perimeter. Set to `null` if you wish to use the `quantity` parameter instead.
	`22`	`+ * @param {integer} [quantity] - The total number of points to return. The step is then calculated based on the length of the Rectangle, divided by this value.`
	`23`	`+ * @param {(array\|Phaser.Geom.Point[])} [out] - An array in which the perimeter points will be stored. If not given, a new array instance is created.`
`24`	`24`	`*`
`25`		`- * @return {(array\|Phaser.Geom.Point[])} [description]`
	`25`	`+ * @return {(array\|Phaser.Geom.Point[])} An array containing the perimeter points from the Rectangle.`
`26`	`26`	`*/`
`27`	`27`	`var MarchingAnts = function (rect, step, quantity, out)`
`28`	`28`	`{`