Fleshing out docs

icbat · web-flow · commit 6d7b28db04df · 2018-04-02T11:03:23.000-05:00
diff --git a/src/math/Linear.js b/src/math/Linear.js
@@ -5,16 +5,16 @@
  */
 
 /**
- * [description]
+ * Calculates a linear (interpolation) value over t.
  *
  * @function Phaser.Math.Linear
  * @since 3.0.0
  *
- * @param {number} p0 - [description]
- * @param {number} p1 - [description]
- * @param {float} t - [description]
+ * @param {number} p0 - The first point
+ * @param {number} p1 - The second point
+ * @param {float} t -The percentage between p0 and p1 to return represented as a number between 0 and 1.
  *
- * @return {number} [description]
+ * @return {number} The step t% of the way between p0 and p1
  */
 var Linear = function (p0, p1, t)
 {

Original file line number	Diff line number	Diff line change
`@@ -5,16 +5,16 @@`
`5`	`5`	`*/`
`6`	`6`
`7`	`7`	`/**`
`8`		`- * [description]`
	`8`	`+ * Calculates a linear (interpolation) value over t.`
`9`	`9`	`*`
`10`	`10`	`* @function Phaser.Math.Linear`
`11`	`11`	`* @since 3.0.0`
`12`	`12`	`*`
`13`		`- * @param {number} p0 - [description]`
`14`		`- * @param {number} p1 - [description]`
`15`		`- * @param {float} t - [description]`
	`13`	`+ * @param {number} p0 - The first point`
	`14`	`+ * @param {number} p1 - The second point`
	`15`	`+ * @param {float} t -The percentage between p0 and p1 to return represented as a number between 0 and 1.`
`16`	`16`	`*`
`17`		`- * @return {number} [description]`
	`17`	`+ * @return {number} The step t% of the way between p0 and p1`
`18`	`18`	`*/`
`19`	`19`	`var Linear = function (p0, p1, t)`
`20`	`20`	`{`