Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-23 13:13:43 +00:00
Code Issues Projects Releases Packages Wiki Activity

jsdoc fixes

Browse source
This commit is contained in:
Richard Davey 2018-02-22 01:07:30 +00:00
parent fe5bd7e6bb
commit 26f0578261
6 changed files with 51 additions and 53 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/animations/Animation.js
View file

@ -54,7 +54,7 @@ var Animation = new Class({
/** /**
* A frame based animation (as opposed to a bone based animation) * A frame based animation (as opposed to a bone based animation)
* *
* @name Phaser.Animations.Animation#key * @name Phaser.Animations.Animation#type
* @type {string} * @type {string}
* @default frame * @default frame
* @since 3.0.0 * @since 3.0.0

2
src/boot/PluginManager.js
View file

@ -161,7 +161,7 @@ var PluginManager = new Class({
* Plugin is the object to instantiate to create the plugin * Plugin is the object to instantiate to create the plugin
* Mapping is what the plugin is injected into the Scene.Systems as (i.e. input) * Mapping is what the plugin is injected into the Scene.Systems as (i.e. input)
* *
* @name PluginManager.register * @method PluginManager.register
* @since 3.0.0 * @since 3.0.0
* *
* @param {string} key - [description] * @param {string} key - [description]

4
src/cameras/sprite3d/Camera.js
View file

@ -54,7 +54,7 @@ var Camera = new Class({
* [description] * [description]
* *
* @name Phaser.Cameras.Sprite3D#displayList * @name Phaser.Cameras.Sprite3D#displayList
* @type {[type]} * @type {Phaser.GameObjects.DisplayList}
* @since 3.0.0 * @since 3.0.0
*/ */
this.displayList = scene.sys.displayList; this.displayList = scene.sys.displayList;
@ -63,7 +63,7 @@ var Camera = new Class({
* [description] * [description]
* *
* @name Phaser.Cameras.Sprite3D#updateList * @name Phaser.Cameras.Sprite3D#updateList
* @type {[type]} * @type {Phaser.GameObjects.UpdateList}
* @since 3.0.0 * @since 3.0.0
*/ */
this.updateList = scene.sys.updateList; this.updateList = scene.sys.updateList;

22
src/cameras/sprite3d/CameraManager.js
View file

@ -29,7 +29,7 @@ var CameraManager = new Class({
/** /**
* [description] * [description]
* *
* @name Phaser.Cameras.Sprite3D#scene * @name Phaser.Cameras.Sprite3D.CameraManager#scene
* @type {Phaser.Scene} * @type {Phaser.Scene}
* @since 3.0.0 * @since 3.0.0
*/ */
@ -38,7 +38,7 @@ var CameraManager = new Class({
/** /**
* [description] * [description]
* *
* @name Phaser.Cameras.Sprite3D#systems * @name Phaser.Cameras.Sprite3D.CameraManager#systems
* @type {Phaser.Scenes.Systems} * @type {Phaser.Scenes.Systems}
* @since 3.0.0 * @since 3.0.0
*/ */
@ -47,7 +47,7 @@ var CameraManager = new Class({
/** /**
* An Array of the Camera objects being managed by this Camera Manager. * An Array of the Camera objects being managed by this Camera Manager.
* *
* @name Phaser.Cameras.Sprite3D#cameras * @name Phaser.Cameras.Sprite3D.CameraManager#cameras
* @type {array} * @type {array}
* @since 3.0.0 * @since 3.0.0
*/ */
@ -97,8 +97,8 @@ var CameraManager = new Class({
* @method Phaser.Cameras.Sprite3D.CameraManager#addOrthographicCamera * @method Phaser.Cameras.Sprite3D.CameraManager#addOrthographicCamera
* @since 3.0.0 * @since 3.0.0
* *
* @param {[type]} width - [description] * @param {number} width - [description]
* @param {[type]} height - [description] * @param {number} height - [description]
* *
* @return {[type]} [description] * @return {[type]} [description]
*/ */
@ -122,9 +122,9 @@ var CameraManager = new Class({
* @method Phaser.Cameras.Sprite3D.CameraManager#addPerspectiveCamera * @method Phaser.Cameras.Sprite3D.CameraManager#addPerspectiveCamera
* @since 3.0.0 * @since 3.0.0
* *
* @param {[type]} fieldOfView - [description] * @param {number} [fieldOfView=80] - [description]
* @param {[type]} width - [description] * @param {number} [width] - [description]
* @param {[type]} height - [description] * @param {number} [height] - [description]
* *
* @return {[type]} [description] * @return {[type]} [description]
*/ */
@ -149,7 +149,7 @@ var CameraManager = new Class({
* @method Phaser.Cameras.Sprite3D.CameraManager#getCamera * @method Phaser.Cameras.Sprite3D.CameraManager#getCamera
* @since 3.0.0 * @since 3.0.0
* *
* @param {[type]} name - [description] * @param {string} name - [description]
* *
* @return {[type]} [description] * @return {[type]} [description]
*/ */
@ -210,8 +210,8 @@ var CameraManager = new Class({
* @method Phaser.Cameras.Sprite3D.CameraManager#update * @method Phaser.Cameras.Sprite3D.CameraManager#update
* @since 3.0.0 * @since 3.0.0
* *
* @param {[type]} timestep - [description] * @param {number} timestep - [description]
* @param {[type]} delta - [description] * @param {number} delta - [description]
*/ */
update: function (timestep, delta) update: function (timestep, delta)
{ {

7
src/device/Features.js
View file

@ -117,11 +117,8 @@ function init ()
// Can't be done on a webgl context // Can't be done on a webgl context
var image = ctx2D.createImageData(1, 1); var image = ctx2D.createImageData(1, 1);
/** // Test to see if ImageData uses CanvasPixelArray or Uint8ClampedArray.
* Test to see if ImageData uses CanvasPixelArray or Uint8ClampedArray. // @author Matt DesLauriers (@mattdesl)
*
* @author Matt DesLauriers (@mattdesl)
*/
isUint8 = image.data instanceof Uint8ClampedArray; isUint8 = image.data instanceof Uint8ClampedArray;
CanvasPool.remove(canvas); CanvasPool.remove(canvas);

67
src/math/Vector4.js
View file

@ -32,7 +32,7 @@ var Vector4 = new Class({
/** /**
* The x component of this Vector. * The x component of this Vector.
* *
* @name Phaser.Math.Vector3#x * @name Phaser.Math.Vector4#x
* @type {number} * @type {number}
* @default 0 * @default 0
* @since 3.0.0 * @since 3.0.0
@ -41,7 +41,7 @@ var Vector4 = new Class({
/** /**
* The y component of this Vector. * The y component of this Vector.
* *
* @name Phaser.Math.Vector3#y * @name Phaser.Math.Vector4#y
* @type {number} * @type {number}
* @default 0 * @default 0
* @since 3.0.0 * @since 3.0.0
@ -50,7 +50,7 @@ var Vector4 = new Class({
/** /**
* The z component of this Vector. * The z component of this Vector.
* *
* @name Phaser.Math.Vector3#z * @name Phaser.Math.Vector4#z
* @type {number} * @type {number}
* @default 0 * @default 0
* @since 3.0.0 * @since 3.0.0
@ -59,7 +59,7 @@ var Vector4 = new Class({
/** /**
* The w component of this Vector. * The w component of this Vector.
* *
* @name Phaser.Math.Vector3#w * @name Phaser.Math.Vector4#w
* @type {number} * @type {number}
* @default 0 * @default 0
* @since 3.0.0 * @since 3.0.0
@ -87,7 +87,7 @@ var Vector4 = new Class({
* @method Phaser.Math.Vector4#clone * @method Phaser.Math.Vector4#clone
* @since 3.0.0 * @since 3.0.0
* *
* @return {[type]} [description] * @return {Phaser.Math.Vector4} [description]
*/ */
clone: function () clone: function ()
{ {
@ -100,9 +100,9 @@ var Vector4 = new Class({
* @method Phaser.Math.Vector4#copy * @method Phaser.Math.Vector4#copy
* @since 3.0.0 * @since 3.0.0
* *
* @param {[type]} src - [description] * @param {Phaser.Math.Vector4} src - [description]
* *
* @return {[type]} [description] * @return {Phaser.Math.Vector4} This Vector4 object.
*/ */
copy: function (src) copy: function (src)
{ {
@ -120,9 +120,9 @@ var Vector4 = new Class({
* @method Phaser.Math.Vector4#equals * @method Phaser.Math.Vector4#equals
* @since 3.0.0 * @since 3.0.0
* *
* @param {[type]} v - [description] * @param {Phaser.Math.Vector4} v - [description]
* *
* @return {[type]} [description] * @return {boolean} [description]
*/ */
equals: function (v) equals: function (v)
{ {
@ -135,12 +135,12 @@ var Vector4 = new Class({
* @method Phaser.Math.Vector4#set * @method Phaser.Math.Vector4#set
* @since 3.0.0 * @since 3.0.0
* *
* @param {[type]} x - [description] * @param {number} x - [description]
* @param {[type]} y - [description] * @param {number} y - [description]
* @param {[type]} z - [description] * @param {number} z - [description]
* @param {[type]} w - [description] * @param {number} w - [description]
* *
* @return {[type]} [description] * @return {Phaser.Math.Vector4} This Vector4 object.
*/ */
set: function (x, y, z, w) set: function (x, y, z, w)
{ {
@ -168,9 +168,9 @@ var Vector4 = new Class({
* @method Phaser.Math.Vector4#add * @method Phaser.Math.Vector4#add
* @since 3.0.0 * @since 3.0.0
* *
* @param {[type]} v - [description] * @param {Phaser.Math.Vector2|Phaser.Math.Vector3|Phaser.Math.Vector4} v - [description]
* *
* @return {[type]} [description] * @return {Phaser.Math.Vector4} This Vector4 object.
*/ */
add: function (v) add: function (v)
{ {
@ -188,9 +188,9 @@ var Vector4 = new Class({
* @method Phaser.Math.Vector4#subtract * @method Phaser.Math.Vector4#subtract
* @since 3.0.0 * @since 3.0.0
* *
* @param {[type]} v - [description] * @param {Phaser.Math.Vector2|Phaser.Math.Vector3|Phaser.Math.Vector4} v - [description]
* *
* @return {[type]} [description] * @return {Phaser.Math.Vector4} This Vector4 object.
*/ */
subtract: function (v) subtract: function (v)
{ {
@ -208,9 +208,9 @@ var Vector4 = new Class({
* @method Phaser.Math.Vector4#scale * @method Phaser.Math.Vector4#scale
* @since 3.0.0 * @since 3.0.0
* *
* @param {[type]} scale - [description] * @param {number} scale - [description]
* *
* @return {[type]} [description] * @return {Phaser.Math.Vector4} This Vector4 object.
*/ */
scale: function (scale) scale: function (scale)
{ {
@ -228,7 +228,7 @@ var Vector4 = new Class({
* @method Phaser.Math.Vector4#length * @method Phaser.Math.Vector4#length
* @since 3.0.0 * @since 3.0.0
* *
* @return {[type]} [description] * @return {number} [description]
*/ */
length: function () length: function ()
{ {
@ -246,7 +246,7 @@ var Vector4 = new Class({
* @method Phaser.Math.Vector4#lengthSq * @method Phaser.Math.Vector4#lengthSq
* @since 3.0.0 * @since 3.0.0
* *
* @return {[type]} [description] * @return {number} [description]
*/ */
lengthSq: function () lengthSq: function ()
{ {
@ -264,7 +264,7 @@ var Vector4 = new Class({
* @method Phaser.Math.Vector4#normalize * @method Phaser.Math.Vector4#normalize
* @since 3.0.0 * @since 3.0.0
* *
* @return {[type]} [description] * @return {Phaser.Math.Vector4} This Vector4 object.
*/ */
normalize: function () normalize: function ()
{ {
@ -295,7 +295,7 @@ var Vector4 = new Class({
* *
* @param {[type]} v - [description] * @param {[type]} v - [description]
* *
* @return {[type]} [description] * @return {number} [description]
*/ */
dot: function (v) dot: function (v)
{ {
@ -311,7 +311,7 @@ var Vector4 = new Class({
* @param {[type]} v - [description] * @param {[type]} v - [description]
* @param {[type]} t - [description] * @param {[type]} t - [description]
* *
* @return {[type]} [description] * @return {Phaser.Math.Vector4} This Vector4 object.
*/ */
lerp: function (v, t) lerp: function (v, t)
{ {
@ -338,7 +338,7 @@ var Vector4 = new Class({
* *
* @param {[type]} v - [description] * @param {[type]} v - [description]
* *
* @return {[type]} [description] * @return {Phaser.Math.Vector4} This Vector4 object.
*/ */
multiply: function (v) multiply: function (v)
{ {
@ -358,7 +358,7 @@ var Vector4 = new Class({
* *
* @param {[type]} v - [description] * @param {[type]} v - [description]
* *
* @return {[type]} [description] * @return {Phaser.Math.Vector4} This Vector4 object.
*/ */
divide: function (v) divide: function (v)
{ {
@ -378,7 +378,7 @@ var Vector4 = new Class({
* *
* @param {[type]} v - [description] * @param {[type]} v - [description]
* *
* @return {[type]} [description] * @return {number} [description]
*/ */
distance: function (v) distance: function (v)
{ {
@ -398,7 +398,7 @@ var Vector4 = new Class({
* *
* @param {[type]} v - [description] * @param {[type]} v - [description]
* *
* @return {[type]} [description] * @return {number} [description]
*/ */
distanceSq: function (v) distanceSq: function (v)
{ {
@ -416,7 +416,7 @@ var Vector4 = new Class({
* @method Phaser.Math.Vector4#negate * @method Phaser.Math.Vector4#negate
* @since 3.0.0 * @since 3.0.0
* *
* @return {[type]} [description] * @return {Phaser.Math.Vector4} This Vector4 object.
*/ */
negate: function () negate: function ()
{ {
@ -436,7 +436,7 @@ var Vector4 = new Class({
* *
* @param {[type]} mat - [description] * @param {[type]} mat - [description]
* *
* @return {[type]} [description] * @return {Phaser.Math.Vector4} This Vector4 object.
*/ */
transformMat4: function (mat) transformMat4: function (mat)
{ {
@ -464,7 +464,7 @@ var Vector4 = new Class({
* *
* @param {[type]} q - [description] * @param {[type]} q - [description]
* *
* @return {[type]} [description] * @return {Phaser.Math.Vector4} This Vector4 object.
*/ */
transformQuat: function (q) transformQuat: function (q)
{ {
@ -497,7 +497,7 @@ var Vector4 = new Class({
* @method Phaser.Math.Vector4#reset * @method Phaser.Math.Vector4#reset
* @since 3.0.0 * @since 3.0.0
* *
* @return {[type]} [description] * @return {Phaser.Math.Vector4} This Vector4 object.
*/ */
reset: function () reset: function ()
{ {
@ -511,6 +511,7 @@ var Vector4 = new Class({
}); });
// TODO: Check if these are required internally, if not, remove.
Vector4.prototype.sub = Vector4.prototype.subtract; Vector4.prototype.sub = Vector4.prototype.subtract;
Vector4.prototype.mul = Vector4.prototype.multiply; Vector4.prototype.mul = Vector4.prototype.multiply;
Vector4.prototype.div = Vector4.prototype.divide; Vector4.prototype.div = Vector4.prototype.divide;