Update LinearInterpolation.js

icbat · web-flow · commit 7153548c36e4 · 2018-04-02T10:54:46.000-05:00
diff --git a/src/math/interpolation/LinearInterpolation.js b/src/math/interpolation/LinearInterpolation.js
@@ -7,15 +7,16 @@
 var Linear = require('../Linear');
 
 /**
- * [description]
+ * A Linear Interpolation Method.
  *
  * @function Phaser.Math.Interpolation.Linear
  * @since 3.0.0
+ * @see https://en.wikipedia.org/wiki/Linear_interpolation
  *
- * @param {float} v - [description]
- * @param {number} k - [description]
+ * @param {number[]} v - The input array of values to interpolate between.
+ * @param {!number} k - The percentage of interploation, between 0 and 1.
  *
- * @return {number} [description]
+ * @return {!number} The interpolated value.
  */
 var LinearInterpolation = function (v, k)
 {

Original file line number	Diff line number	Diff line change
`@@ -7,15 +7,16 @@`
`7`	`7`	`var Linear = require('../Linear');`
`8`	`8`
`9`	`9`	`/**`
`10`		`- * [description]`
	`10`	`+ * A Linear Interpolation Method.`
`11`	`11`	`*`
`12`	`12`	`* @function Phaser.Math.Interpolation.Linear`
`13`	`13`	`* @since 3.0.0`
	`14`	`+ * @see https://en.wikipedia.org/wiki/Linear_interpolation`
`14`	`15`	`*`
`15`		`- * @param {float} v - [description]`
`16`		`- * @param {number} k - [description]`
	`16`	`+ * @param {number[]} v - The input array of values to interpolate between.`
	`17`	`+ * @param {!number} k - The percentage of interploation, between 0 and 1.`
`17`	`18`	`*`
`18`		`- * @return {number} [description]`
	`19`	`+ * @return {!number} The interpolated value.`
`19`	`20`	`*/`
`20`	`21`	`var LinearInterpolation = function (v, k)`
`21`	`22`	`{`