Finished JSDocs

This commit is contained in:
Richard Davey 2020-02-04 14:51:43 +00:00
parent 6e244d5120
commit b5d91f1fdf
5 changed files with 20 additions and 20 deletions

View file

@ -7,15 +7,15 @@
var Factorial = require('./Factorial');
/**
* [description]
* Calculates the Bernstein basis from the three factorial coefficients.
*
* @function Phaser.Math.Bernstein
* @since 3.0.0
*
* @param {number} n - [description]
* @param {number} i - [description]
* @param {number} n - The first value.
* @param {number} i - The second value.
*
* @return {number} [description]
* @return {number} The Bernstein basis of Factorial(n) / Factorial(i) / Factorial(n - i)
*/
var Bernstein = function (n, i)
{

View file

@ -5,16 +5,16 @@
*/
/**
* Calculates a Catmull-Rom value.
* Calculates a Catmull-Rom value from the given points, based on an alpha of 0.5.
*
* @function Phaser.Math.CatmullRom
* @since 3.0.0
*
* @param {number} t - [description]
* @param {number} p0 - [description]
* @param {number} p1 - [description]
* @param {number} p2 - [description]
* @param {number} p3 - [description]
* @param {number} t - The amount to interpolate by.
* @param {number} p0 - The first control point.
* @param {number} p1 - The second control point.
* @param {number} p2 - The third control point.
* @param {number} p3 - The fourth control point.
*
* @return {number} The Catmull-Rom value.
*/

View file

@ -508,12 +508,12 @@ var Matrix3 = new Class({
},
/**
* [description]
* Set the values of this Matrix3 to be normalized from the given Matrix4.
*
* @method Phaser.Math.Matrix3#normalFromMat4
* @since 3.0.0
*
* @param {Phaser.Math.Matrix4} m - [description]
* @param {Phaser.Math.Matrix4} m - The Matrix4 to normalize the values from.
*
* @return {Phaser.Math.Matrix3} This Matrix3.
*/

View file

@ -559,12 +559,12 @@ var Matrix4 = new Class({
},
/**
* [description]
* Multiply the values of this Matrix4 by those given in the `src` argument.
*
* @method Phaser.Math.Matrix4#multiplyLocal
* @since 3.0.0
*
* @param {Phaser.Math.Matrix4} src - [description]
* @param {Phaser.Math.Matrix4} src - The source Matrix4 that this Matrix4 is multiplied by.
*
* @return {Phaser.Math.Matrix4} This Matrix4.
*/
@ -1356,9 +1356,9 @@ var Matrix4 = new Class({
* @method Phaser.Math.Matrix4#yawPitchRoll
* @since 3.0.0
*
* @param {number} yaw - [description]
* @param {number} pitch - [description]
* @param {number} roll - [description]
* @param {number} yaw - The yaw value.
* @param {number} pitch - The pitch value.
* @param {number} roll - The roll value.
*
* @return {Phaser.Math.Matrix4} This Matrix4.
*/

View file

@ -317,13 +317,13 @@ var Quaternion = new Class({
},
/**
* [description]
* Rotates this Quaternion based on the two given vectors.
*
* @method Phaser.Math.Quaternion#rotationTo
* @since 3.0.0
*
* @param {Phaser.Math.Vector3} a - [description]
* @param {Phaser.Math.Vector3} b - [description]
* @param {Phaser.Math.Vector3} a - The transform rotation vector.
* @param {Phaser.Math.Vector3} b - The target rotation vector.
*
* @return {Phaser.Math.Quaternion} This Quaternion.
*/