Skip to content

Commit 80a9461

Browse files
author
hpinkos
committed
cleanup
1 parent 5ac68ec commit 80a9461

11 files changed

+63
-141
lines changed

‎Source/Core/DoublyLinkedList.js

+1-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ define([
2424
});
2525

2626
/**
27-
* @constructor
28-
* @alias DoublyLinkedListNode
27+
* @private
2928
*/
3029
function DoublyLinkedListNode(item, previous, next) {
3130
this.item = item;

‎Source/Core/Event.js

-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ define([
1515
*
1616
* @alias Event
1717
* @constructor
18-
* @namespace
19-
* @exports Event
2018
* @example
2119
* MyObject.prototype.myListener = function(arg1, arg2) {
2220
* this.myArg1Copy = arg1;

‎Source/Core/OrientedBoundingBox.js

-15
Original file line numberDiff line numberDiff line change
@@ -250,21 +250,6 @@ define([
250250

251251
var scratchOffset = new Cartesian3();
252252
var scratchScale = new Cartesian3();
253-
/**
254-
* Computes an OrientedBoundingBox given extents in the east-north-up space of the tangent plane.
255-
*
256-
* @param {Plane} tangentPlane The tangent place corresponding to east-north-up.
257-
* @param {Number} minimumX Minimum X extent in tangent plane space.
258-
* @param {Number} maximumX Maximum X extent in tangent plane space.
259-
* @param {Number} minimumY Minimum Y extent in tangent plane space.
260-
* @param {Number} maximumY Maximum Y extent in tangent plane space.
261-
* @param {Number} minimumZ Minimum Z extent in tangent plane space.
262-
* @param {Number} maximumZ Maximum Z extent in tangent plane space.
263-
* @param {OrientedBoundingBox} [result] The object onto which to store the result.
264-
* @returns {OrientedBoundingBox} The modified result parameter or a new OrientedBoundingBox instance if one was not provided.
265-
*
266-
* @exports fromTangentPlaneExtents
267-
*/
268253
function fromTangentPlaneExtents(tangentPlane, minimumX, maximumX, minimumY, maximumY, minimumZ, maximumZ, result) {
269254
//>>includeStart('debug', pragmas.debug);
270255
if (!defined(minimumX) ||

‎Source/Core/Simon1994PlanetaryPositions.js

+2-9
Original file line numberDiff line numberDiff line change
@@ -333,11 +333,7 @@ define([
333333
var Sl8 = -80 * 1e-7;
334334

335335
var scratchDate = new JulianDate(0, 0.0, TimeStandard.TAI);
336-
/**
337-
* Gets a point describing the motion of the Earth-Moon barycenter according to the equations
338-
* described in section 6.
339-
* @exports computeSimonEarthMoonBarycenter
340-
*/
336+
// Gets a point describing the motion of the Earth-Moon barycenter according to the equations described in section 6.
341337
function computeSimonEarthMoonBarycenter(date, result) {
342338

343339
// t is thousands of years from J2000 TDB
@@ -375,10 +371,7 @@ define([
375371
longitudeOfNode, meanLongitude, result);
376372
}
377373

378-
/**
379-
* Gets a point describing the position of the moon according to the equations described in section 4.
380-
* @exports computeSimonMoon
381-
*/
374+
// Gets a point describing the position of the moon according to the equations described in section 4.
382375
function computeSimonMoon(date, result) {
383376
taiToTdb(date, scratchDate);
384377
var x = (scratchDate.dayNumber - epoch.dayNumber) + ((scratchDate.secondsOfDay - epoch.secondsOfDay)/TimeConstants.SECONDS_PER_DAY);

‎Source/Core/binarySearch.js

-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ define([
88
* Finds an item in a sorted array.
99
*
1010
* @exports binarySearch
11-
* @namespace
1211
* @param {Array} array The sorted array to search.
1312
* @param {*} itemToFind The item to find in the array.
1413
* @param {binarySearch~Comparator} comparator The function to use to compare the item to

‎Source/Core/mergeSort.js

-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@ define([
5757
* A stable merge sort.
5858
*
5959
* @exports mergeSort
60-
* @namespace
6160
* @param {Array} array The array to sort.
6261
* @param {mergeSort~Comparator} comparator The function to use to compare elements in the array.
6362
* @param {*} [userDefinedObject] Any item to pass as the third parameter to <code>comparator</code>.

‎Source/DataSources/KmlTour.js

+4-29
Original file line numberDiff line numberDiff line change
@@ -106,29 +106,15 @@ define([
106106
cancelAllEntries(this._activeEntries);
107107
};
108108

109-
/**
110-
* Stop all activeEntries.
111-
* @param {Array} activeEntries
112-
* @exports cancelAllEntries
113-
*/
109+
// Stop all activeEntries.
114110
function cancelAllEntries(activeEntries) {
115111
for(var entry = activeEntries.pop(); entry !== undefined; entry = activeEntries.pop()) {
116112
entry.stop();
117113
}
118114
}
119115

120-
/**
121-
* Play playlist entry.
122-
* This function is called recursevly with playNext
123-
* and iterates over all entries from playlist.
124-
*
125-
* @param {ViewerWidget} viewer Cesium viewer.
126-
* @param {Object} cameraOptions see {@link Camera#flyTo}.
127-
* @param {Function} allDone a function will be called when all entries from playlist
128-
* being played or user call {@link KmlTour#stop}.
129-
*
130-
* @exports playEntry
131-
*/
116+
// Play playlist entry.
117+
// This function is called recursevly with playNext and iterates over all entries from playlist.
132118
function playEntry(viewer, cameraOptions, allDone) {
133119
var entry = this.playlist[this.playlistIndex];
134120
if (entry) {
@@ -155,18 +141,7 @@ define([
155141
}
156142
}
157143

158-
/**
159-
* Increment playlistIndex and call playEntry
160-
* if terminated isn't true.
161-
*
162-
* @param {ViewerWidget} viewer passed for recursion.
163-
* @param {Object} cameraOptions passed for recursion.
164-
* @param {Function} allDone passed for recursion.
165-
* @param {Boolean} terminated true if active entry was terminated,
166-
* and the whole tour should be terminated.
167-
*
168-
* @exports playNext
169-
*/
144+
// Increment playlistIndex and call playEntry if terminated isn't true.
170145
function playNext(viewer, cameraOptions, allDone, terminated) {
171146
var entry = this.playlist[this.playlistIndex];
172147
this.entryEnd.raiseEvent(entry, terminated);

‎Source/Renderer/CubeMap.js

+2-3
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,8 @@ define([
3333
'use strict';
3434

3535
/**
36-
* @alias CubeMap
37-
* @constructor
38-
*/
36+
* @private
37+
*/
3938
function CubeMap(options) {
4039
options = defaultValue(options, defaultValue.EMPTY_OBJECT);
4140

‎Source/Renderer/Texture.js

+1-2
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,7 @@ define([
3737
'use strict';
3838

3939
/**
40-
* @alias Texture
41-
* @constructor
40+
* @private
4241
*/
4342
function Texture(options) {
4443
options = defaultValue(options, defaultValue.EMPTY_OBJECT);

‎Source/Renderer/createUniform.js

+24-36
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,8 @@ define([
7070
}
7171

7272
/**
73-
* @alias UniformFloat
74-
* @constructor
75-
*/
73+
* @private
74+
*/
7675
function UniformFloat(gl, activeUniform, uniformName, location) {
7776
/**
7877
* @type {String}
@@ -97,9 +96,8 @@ define([
9796
///////////////////////////////////////////////////////////////////////////
9897

9998
/**
100-
* @alias UniformFloatVec2
101-
* @constructor
102-
*/
99+
* @private
100+
*/
103101
function UniformFloatVec2(gl, activeUniform, uniformName, location) {
104102
/**
105103
* @type {String}
@@ -125,9 +123,8 @@ define([
125123
///////////////////////////////////////////////////////////////////////////
126124

127125
/**
128-
* @alias UniformFloatVec3
129-
* @constructor
130-
*/
126+
* @private
127+
*/
131128
function UniformFloatVec3(gl, activeUniform, uniformName, location) {
132129
/**
133130
* @type {String}
@@ -165,9 +162,8 @@ define([
165162
///////////////////////////////////////////////////////////////////////////
166163

167164
/**
168-
* @alias UniformFloatVec4
169-
* @constructor
170-
*/
165+
* @private
166+
*/
171167
function UniformFloatVec4(gl, activeUniform, uniformName, location) {
172168
/**
173169
* @type {String}
@@ -205,9 +201,8 @@ define([
205201
///////////////////////////////////////////////////////////////////////////
206202

207203
/**
208-
* @alias UniformSampler
209-
* @constructor
210-
*/
204+
* @private
205+
*/
211206
function UniformSampler(gl, activeUniform, uniformName, location) {
212207
/**
213208
* @type {String}
@@ -240,9 +235,8 @@ define([
240235
///////////////////////////////////////////////////////////////////////////
241236

242237
/**
243-
* @alias UniformInt
244-
* @constructor
245-
*/
238+
* @private
239+
*/
246240
function UniformInt(gl, activeUniform, uniformName, location) {
247241
/**
248242
* @type {String}
@@ -266,9 +260,8 @@ define([
266260

267261
///////////////////////////////////////////////////////////////////////////
268262
/**
269-
* @alias UniformIntVec2
270-
* @constructor
271-
*/
263+
* @private
264+
*/
272265
function UniformIntVec2(gl, activeUniform, uniformName, location) {
273266
/**
274267
* @type {String}
@@ -293,9 +286,8 @@ define([
293286

294287
///////////////////////////////////////////////////////////////////////////
295288
/**
296-
* @alias UniformIntVec3
297-
* @constructor
298-
*/
289+
* @private
290+
*/
299291
function UniformIntVec3(gl, activeUniform, uniformName, location) {
300292
/**
301293
* @type {String}
@@ -320,9 +312,8 @@ define([
320312

321313
///////////////////////////////////////////////////////////////////////////
322314
/**
323-
* @alias UniformIntVec4
324-
* @constructor
325-
*/
315+
* @private
316+
*/
326317
function UniformIntVec4(gl, activeUniform, uniformName, location) {
327318
/**
328319
* @type {String}
@@ -349,9 +340,8 @@ define([
349340

350341
var scratchUniformArray = new Float32Array(4);
351342
/**
352-
* @alias UniformMat2
353-
* @constructor
354-
*/
343+
* @private
344+
*/
355345
function UniformMat2(gl, activeUniform, uniformName, location) {
356346
/**
357347
* @type {String}
@@ -379,9 +369,8 @@ define([
379369

380370
var scratchMat3Array = new Float32Array(9);
381371
/**
382-
* @alias UniformMat3
383-
* @constructor
384-
*/
372+
* @private
373+
*/
385374
function UniformMat3(gl, activeUniform, uniformName, location) {
386375
/**
387376
* @type {String}
@@ -409,9 +398,8 @@ define([
409398

410399
var scratchMat4Array = new Float32Array(16);
411400
/**
412-
* @alias UniformMat4
413-
* @constructor
414-
*/
401+
* @private
402+
*/
415403
function UniformMat4(gl, activeUniform, uniformName, location) {
416404
/**
417405
* @type {String}

0 commit comments

Comments
 (0)