From 4270660c315ea56a4f163d284a9ada056c11c8be Mon Sep 17 00:00:00 2001 From: Evan Cobb Date: Sun, 8 Apr 2018 14:13:02 -0500 Subject: [PATCH] adding documentation to some files with only one [description] tag --- src/actions/RotateAround.js | 3 ++- src/actions/Shuffle.js | 3 ++- src/boot/Game.js | 2 +- src/dom/AddToDOM.js | 2 +- src/gameobjects/GameObject.js | 3 ++- 5 files changed, 8 insertions(+), 5 deletions(-) diff --git a/src/actions/RotateAround.js b/src/actions/RotateAround.js index 91702d55e..a8b0a7b44 100644 --- a/src/actions/RotateAround.js +++ b/src/actions/RotateAround.js @@ -8,10 +8,11 @@ var RotateAroundDistance = require('../math/RotateAroundDistance'); var DistanceBetween = require('../math/distance/DistanceBetween'); /** - * [description] + * Rotates each item around the given point by the given angle. * * @function Phaser.Actions.RotateAround * @since 3.0.0 + * @see Phaser.Math.RotateAroundDistance * * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return] * diff --git a/src/actions/Shuffle.js b/src/actions/Shuffle.js index 61f722329..d27410319 100644 --- a/src/actions/Shuffle.js +++ b/src/actions/Shuffle.js @@ -7,10 +7,11 @@ var ArrayShuffle = require('../utils/array/Shuffle'); /** - * [description] + * Shuffles the array in place. The shuffled array is both modified and returned. * * @function Phaser.Actions.Shuffle * @since 3.0.0 + * @see Phaser.Utils.Array.Shuffle * * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return] * diff --git a/src/boot/Game.js b/src/boot/Game.js index 014f55727..cadf8964b 100644 --- a/src/boot/Game.js +++ b/src/boot/Game.js @@ -154,7 +154,7 @@ var Game = new Class({ this.cache = new CacheManager(this); /** - * [description] + * An instance of the Data Manager * * @name Phaser.Game#registry * @type {Phaser.Data.DataManager} diff --git a/src/dom/AddToDOM.js b/src/dom/AddToDOM.js index 41216c835..de6aec433 100644 --- a/src/dom/AddToDOM.js +++ b/src/dom/AddToDOM.js @@ -13,7 +13,7 @@ * * @param {HTMLElement} element - The element to be added to the DOM. Usually a Canvas object. * @param {(string|HTMLElement)} [parent] - The parent in which to add the element. Can be a string which is passed to `getElementById` or an actual DOM object. - * @param {boolean} [overflowHidden=true] - [description] + * @param {boolean} [overflowHidden=true] - Whether or not to hide overflowing content inside the parent. * * @return {HTMLElement} The element that was added to the DOM. */ diff --git a/src/gameobjects/GameObject.js b/src/gameobjects/GameObject.js index 0f31888cb..22eb2804a 100644 --- a/src/gameobjects/GameObject.js +++ b/src/gameobjects/GameObject.js @@ -195,10 +195,11 @@ var GameObject = new Class({ }, /** - * [description] + * Adds a DataManager to this object. * * @method Phaser.GameObjects.GameObject#setDataEnabled * @since 3.0.0 + * @see Phaser.Data.DataManager * * @return {Phaser.GameObjects.GameObject} This GameObject. */