From 43b4aad96cae18fe7aa0179353c72e1b23719164 Mon Sep 17 00:00:00 2001 From: Richard Davey Date: Wed, 13 Feb 2019 14:20:51 +0000 Subject: [PATCH] Math typedefs --- src/math/SinCosTableGenerator.js | 10 +--------- src/math/Vector2.js | 9 +-------- src/math/typedefs/SinCosTable.js | 8 ++++++++ src/math/typedefs/Vector2Like.js | 7 +++++++ src/math/typedefs/index.js | 9 +++++++++ 5 files changed, 26 insertions(+), 17 deletions(-) create mode 100644 src/math/typedefs/SinCosTable.js create mode 100644 src/math/typedefs/Vector2Like.js create mode 100644 src/math/typedefs/index.js diff --git a/src/math/SinCosTableGenerator.js b/src/math/SinCosTableGenerator.js index 7f438c7e0..34a8bddc4 100644 --- a/src/math/SinCosTableGenerator.js +++ b/src/math/SinCosTableGenerator.js @@ -4,14 +4,6 @@ * @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License} */ -/** - * @typedef {object} SinCosTable - * - * @property {number} sin - The sine value. - * @property {number} cos - The cosine value. - * @property {number} length - The length. - */ - /** * Generate a series of sine and cosine values. * @@ -23,7 +15,7 @@ * @param {number} [cosAmp=1] - The cosine value amplitude. * @param {number} [frequency=1] - The frequency of the values. * - * @return {SinCosTable} The generated values. + * @return {Phaser.Math.Types.SinCosTable} The generated values. */ var SinCosTableGenerator = function (length, sinAmp, cosAmp, frequency) { diff --git a/src/math/Vector2.js b/src/math/Vector2.js index 99ffee283..5e00b63a5 100644 --- a/src/math/Vector2.js +++ b/src/math/Vector2.js @@ -9,13 +9,6 @@ var Class = require('../utils/Class'); -/** - * @typedef {object} Vector2Like - * - * @property {number} x - The x component. - * @property {number} y - The y component. - */ - /** * @classdesc * A representation of a vector in 2D space. @@ -27,7 +20,7 @@ var Class = require('../utils/Class'); * @constructor * @since 3.0.0 * - * @param {number|Vector2Like} [x] - The x component, or an object with `x` and `y` properties. + * @param {number|Phaser.Math.Types.Vector2Like} [x] - The x component, or an object with `x` and `y` properties. * @param {number} [y] - The y component. */ var Vector2 = new Class({ diff --git a/src/math/typedefs/SinCosTable.js b/src/math/typedefs/SinCosTable.js new file mode 100644 index 000000000..bbdfa610f --- /dev/null +++ b/src/math/typedefs/SinCosTable.js @@ -0,0 +1,8 @@ +/** + * @typedef {object} Phaser.Math.Types.SinCosTable + * @since 3.0.0 + * + * @property {number} sin - The sine value. + * @property {number} cos - The cosine value. + * @property {number} length - The length. + */ diff --git a/src/math/typedefs/Vector2Like.js b/src/math/typedefs/Vector2Like.js new file mode 100644 index 000000000..083616534 --- /dev/null +++ b/src/math/typedefs/Vector2Like.js @@ -0,0 +1,7 @@ +/** + * @typedef {object} Phaser.Math.Types.Vector2Like + * @since 3.0.0 + * + * @property {number} x - The x component. + * @property {number} y - The y component. + */ diff --git a/src/math/typedefs/index.js b/src/math/typedefs/index.js new file mode 100644 index 000000000..9123f039c --- /dev/null +++ b/src/math/typedefs/index.js @@ -0,0 +1,9 @@ +/** + * @author Richard Davey + * @copyright 2019 Photon Storm Ltd. + * @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License} + */ + +/** + * @namespace Phaser.Math.Types + */