8000 Adding jsdocs · ITCSsDeveloper/phaser@bdbf2a1 · GitHub
Skip to content

Commit bdbf2a1

Browse files
committed
Adding jsdocs
1 parent 4ea560c commit bdbf2a1

36 files changed

Lines changed: 414 additions & 83 deletions

v3/src/display/align/in/BottomCenter.js

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,19 @@ var GetBottom = require('../../bounds/GetBottom');
33
var SetCenterX = require('../../bounds/SetCenterX');
44
var SetBottom = require('../../bounds/SetBottom');
55

6+
/**
7+
* [description]
8+
*
9+
* @function Phaser.Display.Align.In.BottomCenter
10+
* @since 3.0.0
11+
*
12+
* @param {Phaser.GameObjects.GameObject} gameObject - [description]
13+
* @param {Phaser.GameObjects.GameObject} container - [description]
14+
* @param {number} [offsetX] - [description]
15+
* @param {number} [offsetY] - [description]
16+
*
17+
* @return {Phaser.GameObjects.GameObject} [description]
18+
*/
619
var BottomCenter = function (gameObject, container, offsetX, offsetY)
720
{
821
if (offsetX === undefined) { offsetX = 0; }

v3/src/display/align/in/BottomLeft.js

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,19 @@ var GetBottom = require('../../bounds/GetBottom');
33
var SetLeft = require('../../bounds/SetLeft');
44
var SetBottom = require('../../bounds/SetBottom');
55

6+
/**
7+
* [description]
8+
*
9+
* @function Phaser.Display.Align.In.BottomLeft
10+
* @since 3.0.0
11+
*
12+
* @param {Phaser.GameObjects.GameObject} gameObject - [description]
13+
* @param {Phaser.GameObjects.GameObject} container - [description]
14+
* @param {number} [offsetX] - [description]
15+
* @param {number} [offsetY] - [description]
16+
*
17+
* @return {Phaser.GameObjects.GameObject} [description]
18+
*/
619
var BottomLeft = function (gameObject, container, offsetX, offsetY)
720
{
821
if (offsetX === undefined) { offsetX = 0; }

v3/src/display/align/in/BottomRight.js

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,19 @@ var GetBottom = require('../../bounds/GetBottom');
33
var SetRight = require('../../bounds/SetRight');
44
var SetBottom = require('../../bounds/SetBottom');
55

6+
/**
7+
* [description]
8+
*
9+
* @function Phaser.Display.Align.In.BottomRight
10+
* @since 3.0.0
11+
*
12+
* @param {Phaser.GameObjects.GameObject} gameObject - [description]
13+
* @param {Phaser.GameObjects.GameObject} container - [description]
14+
* @param {number} [offsetX] - [description]
15+
* @param {number} [offsetY] - [description]
16+
*
17+
* @return {Phaser.GameObjects.GameObject} [description]
18+
*/
619
var BottomRight = function (gameObject, container, offsetX, offsetY)
720
{
821
if (offsetX === undefined) { offsetX = 0; }

v3/src/display/align/in/Center.js

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,19 @@ var GetCenterX = require('../../bounds/GetCenterX');
22
var GetCenterY = require('../../bounds/GetCenterY');
33
var CenterOn = require('../../bounds/CenterOn');
44

5+
/**
6+
* [description]
7+
*
8+
* @function Phaser.Display.Align.In.Center
9+
* @since 3.0.0
10+
*
11+
* @param {Phaser.GameObjects.GameObject} gameObject - [description]
12+
* @param {Phaser.GameObjects.GameObject} container - [description]
13+
* @param {number} [offsetX=0] - [description]
14+
* @param {number} [offsetY=0] - [description]
15+
*
16+
* @return {Phaser.GameObjects.GameObject} [description]
17+
*/
518
var Center = function (gameObject, container, offsetX, offsetY)
619
{
720
if (offsetX === undefined) { offsetX = 0; }

v3/src/display/align/in/LeftCenter.js

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,19 @@ var GetCenterY = require('../../bounds/GetCenterY');
33
var SetLeft = require('../../bounds/SetLeft');
44
var SetCenterY = require('../../bounds/SetCenterY');
55

6+
/**
7+
* [description]
8+
*
9+
* @function Phaser.Display.Align.In.LeftCenter
10+
* @since 3.0.0
11+
*
12+
* @param {Phaser.GameObjects.GameObject} gameObject - [description]
13+
* @param {Phaser.GameObjects.GameObject} container - [description]
14+
* @param {number} [offsetX=0] - [description]
15+
* @param {number} [offsetY=0] - [description]
16+
*
17+
* @return {Phaser.GameObjects.GameObject} [description]
18+
*/
619
var LeftCenter = function (gameObject, container, offsetX, offsetY)
720
{
821
if (offsetX === undefined) { offsetX = 0; }

v3/src/display/align/in/RightCenter.js

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,19 @@ var GetCenterY = require('../../bounds/GetCenterY');
33
var SetRight = require('../../bounds/SetRight');
44
var SetCenterY = require('../../bounds/SetCenterY');
55

6+
/**
7+
* [description]
8+
*
9+
* @function Phaser.Display.Align.In.RightCenter
10+
* @since 3.0.0
11+
*
12+
* @param {Phaser.GameObjects.GameObject} gameObject - [description]
13+
* @param {Phaser.GameObjects.GameObject} container - [description]
14+
* @param {number} [offsetX=0] - [description]
15+
* @param {number} [offsetY=0] - [description]
16+
*
17+
* @return {Phaser.GameObjects.GameObject} [description]
18+
*/
619
var RightCenter = function (gameObject, container, offsetX, offsetY)
720
{
821
if (offsetX === undefined) { offsetX = 0; }

v3/src/display/align/in/TopCenter.js

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,19 @@ var GetTop = require('../../bounds/GetTop');
33
var SetCenterX = require('../../bounds/SetCenterX');
44
var SetTop = require('../../bounds/SetTop');
55

6+
/**
7+
* [description]
8+
*
9+
* @function Phaser.Display.Align.In.TopCenter
10+
* @since 3.0.0
11+
*
12+
* @param {Phaser.GameObjects.GameObject} gameObject - [description]
13+
* @param {Phaser.GameObjects.GameObject} container - [description]
14+
* @param {number} [offsetX=0] - [description]
15+
* @param {number} [offsetY=0] - [description]
16+
*
17+
* @return {Phaser.GameObjects.GameObject} [description]
18+
*/
619
var TopCenter = function (gameObject, container, offsetX, offsetY)
720
{
821
if (offsetX === undefined) { offsetX = 0; }

v3/src/display/align/in/TopLeft.js

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,19 @@ var GetTop = require('../../bounds/GetTop');
33
var SetLeft = require('../../bounds/SetLeft');
44
var SetTop = require('../../bounds/SetTop');
55

6+
/**
7+
* [description]
8+
*
9+
* @function Phaser.Display.Align.In.TopLeft
10+
* @since 3.0.0
11+
*
12+
* @param {Phaser.GameObjects.GameObject} gameObject - [description]
13+
* @param {Phaser.GameObjects.GameObject} container - [description]
14+
* @param {number} [offsetX=0] - [description]
15+
* @param {number} [offsetY=0] - [description]
16+
*
17+
* @return {Phaser.GameObjects.GameObject} [description]
18+
*/
619
var TopLeft = function (gameObject, container, offsetX, offsetY)
720
{
821
if (offsetX === undefined) { offsetX = 0; }

v3/src/display/align/in/TopRight.js

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,19 @@ var GetTop = require('../../bounds/GetTop');
33
var SetRight = require('../../bounds/SetRight');
44
var SetTop = require('../../bounds/SetTop');
55

6+
/**
7+
* [description]
8+
*
9+
* @function Phaser.Display.Align.In.TopRight
10+
* @since 3.0.0
11+
*
12+
* @param {Phaser.GameObjects.GameObject} gameObject - [description]
13+
* @param {Phaser.GameObjects.GameObject} container - [description]
14+
* @param {number} [offsetX=0] - [description]
15+
* @param {number} [offsetY=0] - [description]
16+
*
17+
* @return {Phaser.GameObjects.GameObject} [description]
18+
*/
619
var TopRight = function (gameObject, container, offsetX, offsetY)
720
{
821
if (offsetX === undefined) { offsetX = 0; }

v3/src/display/align/to/BottomCenter.js

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,19 @@ var GetBottom = require('../../bounds/GetBottom');
33
var SetCenterX = require('../../bounds/SetCenterX');
44
var SetTop = require('../../bounds/SetTop');
55

6+
/**
7+
* [description]
8+
*
9+
* @function Phaser.Display.Align.To.BottomCenter
10+
* @since 3.0.0
11+
*
12+
* @param {Phaser.GameObjects.GameObject} gameObject - [description]
13+
* @param {Phaser.GameObjects.GameObject} container - [description]
14+
* @param {number} [offsetX=0] - [description]
15+
* @param {number} [offsetY=0] - [description]
16+
*
17+
* @return {Phaser.GameObjects.GameObject} [description]
18+
*/
619
var BottomCenter = function (gameObject, parent, offsetX, offsetY)
720
{
821
if (offsetX === undefined) { offsetX = 0; }

0 commit comments

Comments
 (0)