Documented Geom CopyFrom functions and some Point functions.

Documented one remaining Ellipse ContainsRect parameter.
This commit is contained in:
Chris Andrew 2018-06-21 18:42:40 +01:00
parent 2388707379
commit 734c0115f9
10 changed files with 28 additions and 28 deletions

View file

@ -16,7 +16,7 @@
* @param {Phaser.Geom.Circle} source - The source Circle to copy the values from.
* @param {Phaser.Geom.Circle} dest - The destination Circle to copy the values to.
*
* @return {Phaser.Geom.Circle} The dest Circle.
* @return {Phaser.Geom.Circle} The destination Circle.
*/
var CopyFrom = function (source, dest)
{

View file

@ -12,7 +12,7 @@ var Contains = require('./Contains');
* @function Phaser.Geom.Ellipse.ContainsRect
* @since 3.0.0
*
* @param {Phaser.Geom.Ellipse} ellipse - [description]
* @param {Phaser.Geom.Ellipse} ellipse - The Ellipse to check.
* @param {(Phaser.Geom.Rectangle|object)} rect - The Rectangle object to check if it's within the Ellipse or not.
*
* @return {boolean} True if all of the Rectangle coordinates are within the ellipse, otherwise false.

View file

@ -16,7 +16,7 @@
* @param {Phaser.Geom.Ellipse} source - The source Ellipse to copy the values from.
* @param {Phaser.Geom.Ellipse} dest - The destination Ellipse to copy the values to.
*
* @return {Phaser.Geom.Ellipse} The dest Ellipse.
* @return {Phaser.Geom.Ellipse} The destination Ellipse.
*/
var CopyFrom = function (source, dest)
{

View file

@ -5,17 +5,17 @@
*/
/**
* Copy the values of one line to another line.
* Copy the values of one line to a destination line.
*
* @function Phaser.Geom.Line.CopyFrom
* @since 3.0.0
*
* @generic {Phaser.Geom.Line} O - [dest,$return]
*
* @param {Phaser.Geom.Line} source - The source line to copy from.
* @param {Phaser.Geom.Line} dest - The destination line to copy to.
* @param {Phaser.Geom.Line} source - The source line to copy the values from.
* @param {Phaser.Geom.Line} dest - The destination line to copy the values to.
*
* @return {Phaser.Geom.Line} The destination line after copying.
* @return {Phaser.Geom.Line} The destination line.
*/
var CopyFrom = function (source, dest)
{

View file

@ -5,16 +5,16 @@
*/
/**
* [description]
* Apply `Math.ceil()` to each coordinate of the given Point.
*
* @function Phaser.Geom.Point.Ceil
* @since 3.0.0
*
* @generic {Phaser.Geom.Point} O - [point,$return]
*
* @param {Phaser.Geom.Point} point - [description]
* @param {Phaser.Geom.Point} point - The Point to ceil.
*
* @return {Phaser.Geom.Point} [description]
* @return {Phaser.Geom.Point} The Point with `Math.ceil()` applied to its coordinates.
*/
var Ceil = function (point)
{

View file

@ -7,14 +7,14 @@
var Point = require('./Point');
/**
* [description]
* Clone the given Point.
*
* @function Phaser.Geom.Point.Clone
* @since 3.0.0
*
* @param {Phaser.Geom.Point} source - [description]
* @param {Phaser.Geom.Point} source - The source Point to clone.
*
* @return {Phaser.Geom.Point} [description]
* @return {Phaser.Geom.Point} The cloned Point.
*/
var Clone = function (source)
{

View file

@ -5,17 +5,17 @@
*/
/**
* [description]
* Copy the values of one Point to a destination Point.
*
* @function Phaser.Geom.Point.CopyFrom
* @since 3.0.0
*
* @generic {Phaser.Geom.Point} O - [dest,$return]
*
* @param {Phaser.Geom.Point} source - [description]
* @param {Phaser.Geom.Point} dest - [description]
* @param {Phaser.Geom.Point} source - The source Point to copy the values from.
* @param {Phaser.Geom.Point} dest - The destination Point to copy the values to.
*
* @return {Phaser.Geom.Point} [description]
* @return {Phaser.Geom.Point} The destination Point.
*/
var CopyFrom = function (source, dest)
{

View file

@ -5,16 +5,16 @@
*/
/**
* [description]
* Apply `Math.ceil()` to each coordinate of the given Point.
*
* @function Phaser.Geom.Point.Floor
* @since 3.0.0
*
* @generic {Phaser.Geom.Point} O - [point,$return]
*
* @param {Phaser.Geom.Point} point - [description]
* @param {Phaser.Geom.Point} point - The Point to floor.
*
* @return {Phaser.Geom.Point} [description]
* @return {Phaser.Geom.Point} The Point with `Math.floor()` applied to its coordinates.
*/
var Floor = function (point)
{

View file

@ -5,17 +5,17 @@
*/
/**
* [description]
* Copy the values of one Rectangle to a destination Rectangle.
*
* @function Phaser.Geom.Rectangle.CopyFrom
* @since 3.0.0
*
* @generic {Phaser.Geom.Rectangle} O - [dest,$return]
*
* @param {Phaser.Geom.Rectangle} source - [description]
* @param {Phaser.Geom.Rectangle} dest - [description]
* @param {Phaser.Geom.Rectangle} source - The source Rectangle to copy the values from.
* @param {Phaser.Geom.Rectangle} dest - The destination Rectangle to copy the values to.
*
* @return {Phaser.Geom.Rectangle} [description]
* @return {Phaser.Geom.Rectangle} The destination Rectangle.
*/
var CopyFrom = function (source, dest)
{

View file

@ -5,17 +5,17 @@
*/
/**
* [description]
* Copy the values of one Triangle to a destination Triangle.
*
* @function Phaser.Geom.Triangle.CopyFrom
* @since 3.0.0
*
* @generic {Phaser.Geom.Triangle} O - [dest,$return]
*
* @param {Phaser.Geom.Triangle} source - [description]
* @param {Phaser.Geom.Triangle} dest - [description]
* @param {Phaser.Geom.Triangle} source - The source Triangle to copy the values from.
* @param {Phaser.Geom.Triangle} dest - The destination Triangle to copy the values to.
*
* @return {Phaser.Geom.Triangle} [description]
* @return {Phaser.Geom.Triangle} The destination Triangle.
*/
var CopyFrom = function (source, dest)
{