From ead3537d45d154549223e2a4170559b13ae96f9a Mon Sep 17 00:00:00 2001 From: Daniel <24710205+Fabadiculous@users.noreply.github.com> Date: Thu, 19 Apr 2018 08:31:21 +1000 Subject: [PATCH 1/6] Added docs for PlayAnimation --- src/actions/PlayAnimation.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/actions/PlayAnimation.js b/src/actions/PlayAnimation.js index 86e45f8e4..9756be6f6 100644 --- a/src/actions/PlayAnimation.js +++ b/src/actions/PlayAnimation.js @@ -13,8 +13,8 @@ * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return] * * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action. - * @param {string} key - [description] - * @param {(string|integer)} [startFrame] - [description] + * @param {string} key - The name of the animation to play + * @param {(string|integer)} [startFrame] - The starting frame of the animation with the given key * * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action. */ From f983f121d4dd680c1fbfd7e99863888ea9237896 Mon Sep 17 00:00:00 2001 From: Daniel <24710205+Fabadiculous@users.noreply.github.com> Date: Thu, 19 Apr 2018 08:36:57 +1000 Subject: [PATCH 2/6] Add docs for PlayAnimation --- src/actions/PlayAnimation.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/actions/PlayAnimation.js b/src/actions/PlayAnimation.js index 9756be6f6..1d563817d 100644 --- a/src/actions/PlayAnimation.js +++ b/src/actions/PlayAnimation.js @@ -5,7 +5,7 @@ */ /** - * [description] + * Play an animation with the given key, starting at the given startFrame on all Game Objects in items * * @function Phaser.Actions.PlayAnimation * @since 3.0.0 From 000fd9fd9674c78f2c24fc4670eeaabe3b940d93 Mon Sep 17 00:00:00 2001 From: Daniel <24710205+Fabadiculous@users.noreply.github.com> Date: Thu, 19 Apr 2018 16:18:48 +1000 Subject: [PATCH 3/6] Completed all description tags --- src/geom/point/Point.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/geom/point/Point.js b/src/geom/point/Point.js index 0393c3efe..51aa31d86 100644 --- a/src/geom/point/Point.js +++ b/src/geom/point/Point.js @@ -8,7 +8,7 @@ var Class = require('../../utils/Class'); /** * @classdesc - * [description] + * Defines a Popint in 2D space, with an x and y component * * @class Point * @memberOf Phaser.Geom @@ -49,7 +49,7 @@ var Point = new Class({ }, /** - * [description] + * Set the x and y coordinates of the point to the given values * * @method Phaser.Geom.Point#setTo * @since 3.0.0 From 29799f36d02ee5c5b8475791543c683adf94dfec Mon Sep 17 00:00:00 2001 From: Daniel <24710205+Fabadiculous@users.noreply.github.com> Date: Thu, 19 Apr 2018 16:27:32 +1000 Subject: [PATCH 4/6] All description tags filled --- src/geom/line/Random.js | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/geom/line/Random.js b/src/geom/line/Random.js index 7a82ac745..d6530ddda 100644 --- a/src/geom/line/Random.js +++ b/src/geom/line/Random.js @@ -7,17 +7,17 @@ var Point = require('../point/Point'); /** - * [description] + * Returns a random point on a given line * * @function Phaser.Geom.Line.Random * @since 3.0.0 * * @generic {Phaser.Geom.Point} O - [out,$return] * - * @param {Phaser.Geom.Line} line - [description] - * @param {(Phaser.Geom.Point|object)} [out] - [description] + * @param {Phaser.Geom.Line} line - The Line to calculate the random Point on + * @param {(Phaser.Geom.Point|object)} [out] - An instance of a Point to be modified * - * @return {(Phaser.Geom.Point|object)} [description] + * @return {(Phaser.Geom.Point|object)} A random Point on the Line */ var Random = function (line, out) { From 58964da2869fb96036c1d90cfb51c56809a2c4fe Mon Sep 17 00:00:00 2001 From: Daniel <24710205+Fabadiculous@users.noreply.github.com> Date: Thu, 19 Apr 2018 16:33:14 +1000 Subject: [PATCH 5/6] Filled description tags for constructor, x1, x2, y1, y2, getPoint return statement, getRandomPoint and setTo methods --- src/geom/line/Line.js | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/src/geom/line/Line.js b/src/geom/line/Line.js index 1b65e23c1..9098ca8d8 100644 --- a/src/geom/line/Line.js +++ b/src/geom/line/Line.js @@ -19,10 +19,10 @@ var Vector2 = require('../../math/Vector2'); * @constructor * @since 3.0.0 * - * @param {number} [x1=0] - [description] - * @param {number} [y1=0] - [description] - * @param {number} [x2=0] - [description] - * @param {number} [y2=0] - [description] + * @param {number} [x1=0] - The x coordinate of the lines starting point + * @param {number} [y1=0] - The y coordinate of the lines starting point + * @param {number} [x2=0] - The x coordinate of the lines ending point + * @param {number} [y2=0] - The y coordinate of the lines ending point */ var Line = new Class({ @@ -36,7 +36,7 @@ var Line = new Class({ if (y2 === undefined) { y2 = 0; } /** - * [description] + * The x coordinate of the lines starting point * * @name Phaser.Geom.Line#x1 * @type {number} @@ -45,7 +45,7 @@ var Line = new Class({ this.x1 = x1; /** - * [description] + * The y coordinate of the lines starting point * * @name Phaser.Geom.Line#y1 * @type {number} @@ -54,7 +54,7 @@ var Line = new Class({ this.y1 = y1; /** - * [description] + * The x coordinate of the lines ending point * * @name Phaser.Geom.Line#x2 * @type {number} @@ -63,7 +63,7 @@ var Line = new Class({ this.x2 = x2; /** - * [description] + * The y coordinate of the lines ending point * * @name Phaser.Geom.Line#y2 * @type {number} @@ -83,7 +83,7 @@ var Line = new Class({ * @param {float} position - [description] * @param {(Phaser.Geom.Point|object)} [output] - [description] * - * @return {(Phaser.Geom.Point|object)} A Point, or point-like object, containing the coordinates of the point around the ellipse. + * @return {(Phaser.Geom.Point|object)} A Point, or point-like object, containing the coordinates of the point on the line */ getPoint: function (position, output) { @@ -110,16 +110,16 @@ var Line = new Class({ }, /** - * [description] + * Get a random point on the Line * * @method Phaser.Geom.Line#getRandomPoint * @since 3.0.0 * * @generic {Phaser.Geom.Point} O - [point,$return] * - * @param {(Phaser.Geom.Point|object)} [point] - [description] + * @param {(Phaser.Geom.Point|object)} [point] - An instance of a Point to be modified * - * @return {Phaser.Geom.Point} [description] + * @return {Phaser.Geom.Point} A random Point on the Line */ getRandomPoint: function (point) { @@ -127,15 +127,15 @@ var Line = new Class({ }, /** - * [description] + * Set new coordinates for the line endpoints * * @method Phaser.Geom.Line#setTo * @since 3.0.0 * - * @param {number} [x1=0] - [description] - * @param {number} [y1=0] - [description] - * @param {number} [x2=0] - [description] - * @param {number} [y2=0] - [description] + * @param {number} [x1=0] - The x coordinate of the lines starting point + * @param {number} [y1=0] - The y coordinate of the lines starting point + * @param {number} [x2=0] - The x coordinate of the lines ending point + * @param {number} [y2=0] - The y coordinate of the lines ending point * * @return {Phaser.Geom.Line} This Line object. */ From 24afeded9b31b844ec49d6a48e61c5afc9f54b38 Mon Sep 17 00:00:00 2001 From: Daniel <24710205+Fabadiculous@users.noreply.github.com> Date: Thu, 19 Apr 2018 21:59:27 +1000 Subject: [PATCH 6/6] Add full stops at end of descriptions --- src/actions/PlayAnimation.js | 6 +++--- src/geom/line/Line.js | 34 +++++++++++++++++----------------- src/geom/line/Random.js | 8 ++++---- src/geom/point/Point.js | 4 ++-- 4 files changed, 26 insertions(+), 26 deletions(-) diff --git a/src/actions/PlayAnimation.js b/src/actions/PlayAnimation.js index 1d563817d..a359a4355 100644 --- a/src/actions/PlayAnimation.js +++ b/src/actions/PlayAnimation.js @@ -5,7 +5,7 @@ */ /** - * Play an animation with the given key, starting at the given startFrame on all Game Objects in items + * Play an animation with the given key, starting at the given startFrame on all Game Objects in items. * * @function Phaser.Actions.PlayAnimation * @since 3.0.0 @@ -13,8 +13,8 @@ * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return] * * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action. - * @param {string} key - The name of the animation to play - * @param {(string|integer)} [startFrame] - The starting frame of the animation with the given key + * @param {string} key - The name of the animation to play. + * @param {(string|integer)} [startFrame] - The starting frame of the animation with the given key. * * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action. */ diff --git a/src/geom/line/Line.js b/src/geom/line/Line.js index 9098ca8d8..39692ea53 100644 --- a/src/geom/line/Line.js +++ b/src/geom/line/Line.js @@ -19,10 +19,10 @@ var Vector2 = require('../../math/Vector2'); * @constructor * @since 3.0.0 * - * @param {number} [x1=0] - The x coordinate of the lines starting point - * @param {number} [y1=0] - The y coordinate of the lines starting point - * @param {number} [x2=0] - The x coordinate of the lines ending point - * @param {number} [y2=0] - The y coordinate of the lines ending point + * @param {number} [x1=0] - The x coordinate of the lines starting point. + * @param {number} [y1=0] - The y coordinate of the lines starting point. + * @param {number} [x2=0] - The x coordinate of the lines ending point. + * @param {number} [y2=0] - The y coordinate of the lines ending point. */ var Line = new Class({ @@ -36,7 +36,7 @@ var Line = new Class({ if (y2 === undefined) { y2 = 0; } /** - * The x coordinate of the lines starting point + * The x coordinate of the lines starting point. * * @name Phaser.Geom.Line#x1 * @type {number} @@ -45,7 +45,7 @@ var Line = new Class({ this.x1 = x1; /** - * The y coordinate of the lines starting point + * The y coordinate of the lines starting point. * * @name Phaser.Geom.Line#y1 * @type {number} @@ -54,7 +54,7 @@ var Line = new Class({ this.y1 = y1; /** - * The x coordinate of the lines ending point + * The x coordinate of the lines ending point. * * @name Phaser.Geom.Line#x2 * @type {number} @@ -63,7 +63,7 @@ var Line = new Class({ this.x2 = x2; /** - * The y coordinate of the lines ending point + * The y coordinate of the lines ending point. * * @name Phaser.Geom.Line#y2 * @type {number} @@ -83,7 +83,7 @@ var Line = new Class({ * @param {float} position - [description] * @param {(Phaser.Geom.Point|object)} [output] - [description] * - * @return {(Phaser.Geom.Point|object)} A Point, or point-like object, containing the coordinates of the point on the line + * @return {(Phaser.Geom.Point|object)} A Point, or point-like object, containing the coordinates of the point on the line. */ getPoint: function (position, output) { @@ -110,16 +110,16 @@ var Line = new Class({ }, /** - * Get a random point on the Line + * Get a random Point on the Line. * * @method Phaser.Geom.Line#getRandomPoint * @since 3.0.0 * * @generic {Phaser.Geom.Point} O - [point,$return] * - * @param {(Phaser.Geom.Point|object)} [point] - An instance of a Point to be modified + * @param {(Phaser.Geom.Point|object)} [point] - An instance of a Point to be modified. * - * @return {Phaser.Geom.Point} A random Point on the Line + * @return {Phaser.Geom.Point} A random Point on the Line. */ getRandomPoint: function (point) { @@ -127,15 +127,15 @@ var Line = new Class({ }, /** - * Set new coordinates for the line endpoints + * Set new coordinates for the line endpoints. * * @method Phaser.Geom.Line#setTo * @since 3.0.0 * - * @param {number} [x1=0] - The x coordinate of the lines starting point - * @param {number} [y1=0] - The y coordinate of the lines starting point - * @param {number} [x2=0] - The x coordinate of the lines ending point - * @param {number} [y2=0] - The y coordinate of the lines ending point + * @param {number} [x1=0] - The x coordinate of the lines starting point. + * @param {number} [y1=0] - The y coordinate of the lines starting point. + * @param {number} [x2=0] - The x coordinate of the lines ending point. + * @param {number} [y2=0] - The y coordinate of the lines ending point. * * @return {Phaser.Geom.Line} This Line object. */ diff --git a/src/geom/line/Random.js b/src/geom/line/Random.js index d6530ddda..8fc8af9d2 100644 --- a/src/geom/line/Random.js +++ b/src/geom/line/Random.js @@ -7,17 +7,17 @@ var Point = require('../point/Point'); /** - * Returns a random point on a given line + * Returns a random point on a given Line. * * @function Phaser.Geom.Line.Random * @since 3.0.0 * * @generic {Phaser.Geom.Point} O - [out,$return] * - * @param {Phaser.Geom.Line} line - The Line to calculate the random Point on - * @param {(Phaser.Geom.Point|object)} [out] - An instance of a Point to be modified + * @param {Phaser.Geom.Line} line - The Line to calculate the random Point on. + * @param {(Phaser.Geom.Point|object)} [out] - An instance of a Point to be modified. * - * @return {(Phaser.Geom.Point|object)} A random Point on the Line + * @return {(Phaser.Geom.Point|object)} A random Point on the Line. */ var Random = function (line, out) { diff --git a/src/geom/point/Point.js b/src/geom/point/Point.js index 51aa31d86..79fc20c33 100644 --- a/src/geom/point/Point.js +++ b/src/geom/point/Point.js @@ -8,7 +8,7 @@ var Class = require('../../utils/Class'); /** * @classdesc - * Defines a Popint in 2D space, with an x and y component + * Defines a Point in 2D space, with an x and y component. * * @class Point * @memberOf Phaser.Geom @@ -49,7 +49,7 @@ var Point = new Class({ }, /** - * Set the x and y coordinates of the point to the given values + * Set the x and y coordinates of the point to the given values. * * @method Phaser.Geom.Point#setTo * @since 3.0.0