Skip to content

Commit 0f87535

Browse files
authored
Merge pull request phaserjs#3607 from Fabadiculous/docs
Docs for GetPhysicsPlugins, Factorial, FloatBetween and Difference
2 parents 116e62f + 96d1b69 commit 0f87535

4 files changed

Lines changed: 13 additions & 13 deletions

File tree

src/math/Difference.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
*/
66

77
/**
8-
* [description]
8+
* Calculates the positive difference of two given numbers.
99
*
1010
* @function Phaser.Math.Difference
1111
* @since 3.0.0
1212
*
13-
* @param {number} a - [description]
14-
* @param {number} b - [description]
13+
* @param {number} a - The first number in the calculation.
14+
* @param {number} b - The second number in the calculation.
1515
*
16-
* @return {number} [description]
16+
* @return {number} The positive difference of the two given numbers.
1717
*/
1818
var Difference = function (a, b)
1919
{

src/math/Factorial.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
*/
66

77
/**
8-
* [description]
8+
* Calculates the factorial of a given number for integer values greater than 0.
99
*
1010
* @function Phaser.Math.Factorial
1111
* @since 3.0.0
1212
*
13-
* @param {number} value - [description]
13+
* @param {number} value - A positive integer to calculate the factorial of.
1414
*
15-
* @return {number} [description]
15+
* @return {number} The factorial of the given number.
1616
*/
1717
var Factorial = function (value)
1818
{

src/math/FloatBetween.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
*/
66

77
/**
8-
* [description]
8+
* Generate a random floating point number between the two given bounds, minimum inclusive, maximum exclusive.
99
*
1010
* @function Phaser.Math.FloatBetween
1111
* @since 3.0.0
1212
*
13-
* @param {float} min - [description]
14-
* @param {float} max - [description]
13+
* @param {float} min - The lower bound for the float, inclusive.
14+
* @param {float} max - The upper bound for the float exclusive.
1515
*
16-
* @return {float} [description]
16+
* @return {float} A random float within the given range.
1717
*/
1818
var FloatBetween = function (min, max)
1919
{

src/scene/GetPhysicsPlugins.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ var UppercaseFirst = require('../utils/string/UppercaseFirst');
1313
* @function Phaser.Scenes.GetPhysicsPlugins
1414
* @since 3.0.0
1515
*
16-
* @param {Phaser.Scenes.Systems} sys - [description]
16+
* @param {Phaser.Scenes.Systems} sys - The scene system to get the physics systems of.
1717
*
18-
* @return {array} [description]
18+
* @return {array} An array of Physics systems to start for this Scene.
1919
*/
2020
var GetPhysicsPlugins = function (sys)
2121
{

0 commit comments

Comments
 (0)