Skip to content

Commit 4cd8787

Browse files
committed
Fix some JSDoc descriptions
1 parent 19c6c94 commit 4cd8787

5 files changed

Lines changed: 16 additions & 28 deletions

File tree

plugins/camera3d/src/Camera.js

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -112,13 +112,12 @@ var Camera = new Class({
112112
*/
113113
this.position = new Vector3();
114114

115-
// The mapping from 3D size units to pixels.
116-
// In the default case 1 3D unit = 128 pixels. So a sprite that is
117-
// 256 x 128 px in size will be 2 x 1 units.
118-
// Change to whatever best fits your game assets.
119115

120116
/**
121-
* [description]
117+
* The mapping from 3D size units to pixels.
118+
* In the default case 1 3D unit = 128 pixels. So a sprite that is
119+
* 256 x 128 px in size will be 2 x 1 units.
120+
* Change to whatever best fits your game assets.
122121
*
123122
* @name Phaser.Cameras.Sprite3D#pixelScale
124123
* @type {number}

src/curves/Curve.js

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -203,10 +203,8 @@ var Curve = new Class({
203203
return this.getPointAt(1, out);
204204
},
205205

206-
// Get total curve arc length
207-
208206
/**
209-
* [description]
207+
* Get total curve arc length
210208
*
211209
* @method Phaser.Curves.Curve#getLength
212210
* @since 3.0.0
@@ -220,10 +218,9 @@ var Curve = new Class({
220218
return lengths[lengths.length - 1];
221219
},
222220

223-
// Get list of cumulative segment lengths
224221

225222
/**
226-
* [description]
223+
* Get list of cumulative segment lengths
227224
*
228225
* @method Phaser.Curves.Curve#getLengths
229226
* @since 3.0.0
@@ -382,13 +379,11 @@ var Curve = new Class({
382379
return this.getPointAt(0, out);
383380
},
384381

385-
// Returns a unit vector tangent at t
386-
// In case any sub curve does not implement its tangent derivation,
387-
// 2 points a small delta apart will be used to find its gradient
388-
// which seems to give a reasonable approximation
389-
390382
/**
391-
* [description]
383+
* Returns a unit vector tangent at t
384+
* In case any sub curve does not implement its tangent derivation,
385+
* 2 points a small delta apart will be used to find its gradient
386+
* which seems to give a reasonable approximation
392387
*
393388
* @method Phaser.Curves.Curve#getTangent
394389
* @since 3.0.0

src/curves/path/Path.js

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -690,10 +690,8 @@ var Path = new Class({
690690
return out.copy(this.startPoint);
691691
},
692692

693-
// Creates a line curve from the previous end point to x/y
694-
695693
/**
696-
* [description]
694+
* Creates a line curve from the previous end point to x/y
697695
*
698696
* @method Phaser.Curves.Path#lineTo
699697
* @since 3.0.0
@@ -780,10 +778,8 @@ var Path = new Class({
780778
};
781779
},
782780

783-
// cacheLengths must be recalculated.
784-
785781
/**
786-
* [description]
782+
* cacheLengths must be recalculated.
787783
*
788784
* @method Phaser.Curves.Path#updateArcLengths
789785
* @since 3.0.0

src/geom/rectangle/GetSize.js

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,10 @@
66

77
var Point = require('../point/Point');
88

9-
// The size of the Rectangle object, expressed as a Point object
10-
// with the values of the width and height properties.
119

1210
/**
13-
* [description]
11+
* The size of the Rectangle object, expressed as a Point object
12+
* with the values of the width and height properties.
1413
*
1514
* @function Phaser.Geom.Rectangle.GetSize
1615
* @since 3.0.0

src/geom/rectangle/MarchingAnts.js

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,10 @@
77
var Perimeter = require('./Perimeter');
88
var Point = require('../point/Point');
99

10-
// Return an array of points from the perimeter of the rectangle
11-
// each spaced out based on the quantity or step required
1210

1311
/**
14-
* [description]
12+
* Return an array of points from the perimeter of the rectangle
13+
* each spaced out based on the quantity or step required
1514
*
1615
* @function Phaser.Geom.Rectangle.MarchingAnts
1716
* @since 3.0.0

0 commit comments

Comments
 (0)