Merge pull request CesiumGS#6899 from bampakoa/docs

[WIP]: Improve jsdoc tags for tsd-jsdoc integration

Author: Hannah

Source/Core/BingMapsGeocoderService.js

@@ -44,7 +44,7 @@ define([
         /**
          * The URL endpoint for the Bing geocoder service
          * @type {String}
-         * @memberof {BingMapsGeocoderService.prototype}
+         * @memberof BingMapsGeocoderService.prototype
          * @readonly
          */
         url : {
@@ -56,7 +56,7 @@ define([
         /**
          * The key for the Bing geocoder service
          * @type {String}
-         * @memberof {BingMapsGeocoderService.prototype}
+         * @memberof BingMapsGeocoderService.prototype
          * @readonly
          */
         key : {

Source/Core/DoublyLinkedList.js

@@ -23,6 +23,9 @@ define([
         }
     });
 
+    /**
+     * @private
+     */
     function DoublyLinkedListNode(item, previous, next) {
         this.item = item;
         this.previous  = previous;

Source/Core/EarthOrientationParameters.js

@@ -136,7 +136,7 @@ define([
      * Gets a promise that, when resolved, indicates that the EOP data has been loaded and is
      * ready to use.
      *
-     * @returns {Promise.<undefined>} The promise.
+     * @returns {Promise} The promise.
      *
      * @see when
      */

Source/Core/Event.js

@@ -15,7 +15,6 @@ define([
      *
      * @alias Event
      * @constructor
-     *
      * @example
      * MyObject.prototype.myListener = function(arg1, arg2) {
      *     this.myArg1Copy = arg1;

Source/Core/Fullscreen.js

@@ -20,6 +20,7 @@ define([
      * Browser-independent functions for working with the standard fullscreen API.
      *
      * @exports Fullscreen
+     * @namespace
      *
      * @see {@link http://dvcs.w3.org/hg/fullscreen/raw-file/tip/Overview.html|W3C Fullscreen Living Specification}
      */

Source/Core/Iau2006XysData.js

@@ -96,7 +96,7 @@ define([
      *                 the Terrestrial Time (TT) time standard.
      * @param {Number} stopSecondTT The seconds past noon of the end of the interval to preload, expressed in
      *                 the Terrestrial Time (TT) time standard.
-     * @returns {Promise.<undefined>} A promise that, when resolved, indicates that the requested interval has been
+     * @returns {Promise} A promise that, when resolved, indicates that the requested interval has been
      *                    preloaded.
      */
     Iau2006XysData.prototype.preload = function(startDayTT, startSecondTT, stopDayTT, stopSecondTT) {

Source/Core/IauOrientationAxes.js

@@ -80,7 +80,7 @@ define([
      *
      * @param {JulianDate} date The date to evaluate the matrix.
      * @param {Matrix3} result The object onto which to store the result.
-     * @returns {Matrix} The modified result parameter or a new instance of the rotation from ICRF to Fixed.
+     * @returns {Matrix3} The modified result parameter or a new instance of the rotation from ICRF to Fixed.
      */
     IauOrientationAxes.prototype.evaluate = function(date, result) {
         if (!defined(date)) {

Source/Core/IntersectionTests.js

@@ -28,6 +28,7 @@ define([
      * Functions for computing the intersection between geometries such as rays, planes, triangles, and ellipsoids.
      *
      * @exports IntersectionTests
+     * @namespace
      */
     var IntersectionTests = {};
 

Source/Core/MapboxApi.js

@@ -6,6 +6,9 @@ define([
         defined) {
     'use strict';
 
+    /**
+     * @exports MapboxApi
+     */
     var MapboxApi = {};
 
     /**

Source/Core/OrientedBoundingBox.js

@@ -250,19 +250,6 @@ define([
 
     var scratchOffset = new Cartesian3();
     var scratchScale = new Cartesian3();
-    /**
-     * Computes an OrientedBoundingBox given extents in the east-north-up space of the tangent plane.
-     *
-     * @param {Plane} tangentPlane The tangent place corresponding to east-north-up.
-     * @param {Number} minimumX Minimum X extent in tangent plane space.
-     * @param {Number} maximumX Maximum X extent in tangent plane space.
-     * @param {Number} minimumY Minimum Y extent in tangent plane space.
-     * @param {Number} maximumY Maximum Y extent in tangent plane space.
-     * @param {Number} minimumZ Minimum Z extent in tangent plane space.
-     * @param {Number} maximumZ Maximum Z extent in tangent plane space.
-     * @param {OrientedBoundingBox} [result] The object onto which to store the result.
-     * @returns {OrientedBoundingBox} The modified result parameter or a new OrientedBoundingBox instance if one was not provided.
-     */
     function fromTangentPlaneExtents(tangentPlane, minimumX, maximumX, minimumY, maximumY, minimumZ, maximumZ, result) {
         //>>includeStart('debug', pragmas.debug);
         if (!defined(minimumX) ||

Source/Core/PeliasGeocoderService.js

@@ -47,7 +47,7 @@ define([
         /**
          * The Resource used to access the Pelias endpoint.
          * @type {Resource}
-         * @memberof {PeliasGeocoderService.prototype}
+         * @memberof PeliasGeocoderService.prototype
          * @readonly
          */
         url: {

Source/Core/Request.js

@@ -15,9 +15,10 @@ define([
      *
      * @alias Request
      * @constructor
-     *
+     * @namespace
+     * @exports Request
      * @param {Object} [options] An object with the following properties:
-     * @param {Boolean} [options.url] The url to request.
+     * @param {String} [options.url] The url to request.
      * @param {Request~RequestCallback} [options.requestFunction] The function that makes the actual data request.
      * @param {Request~CancelCallback} [options.cancelFunction] The function that is called when the request is cancelled.
      * @param {Request~PriorityCallback} [options.priorityFunction] The function that is called to update the request's priority, which occurs once per frame.

Source/Core/Simon1994PlanetaryPositions.js

@@ -333,11 +333,7 @@ define([
     var Sl8 = -80 * 1e-7;
 
     var scratchDate = new JulianDate(0, 0.0, TimeStandard.TAI);
-    /**
-     * Gets a point describing the motion of the Earth-Moon barycenter according to the equations
-     * described in section 6.
-     */
-
+     // Gets a point describing the motion of the Earth-Moon barycenter according to the equations described in section 6.
     function computeSimonEarthMoonBarycenter(date, result) {
 
         // t is thousands of years from J2000 TDB
@@ -375,9 +371,7 @@ define([
                 longitudeOfNode, meanLongitude, result);
     }
 
-    /**
-     * Gets a point describing the position of the moon according to the equations described in section 4.
-     */
+     // Gets a point describing the position of the moon according to the equations described in section 4.
     function computeSimonMoon(date, result) {
         taiToTdb(date, scratchDate);
         var x = (scratchDate.dayNumber - epoch.dayNumber) + ((scratchDate.secondsOfDay - epoch.secondsOfDay)/TimeConstants.SECONDS_PER_DAY);
@@ -481,11 +475,9 @@ define([
                                    longitudeOfNode, meanLongitude, result);
     }
 
-    /**
-     * Gets a point describing the motion of the Earth.  This point uses the Moon point and
-     * the 1992 mu value (ratio between Moon and Earth masses) in Table 2 of the paper in order
-     * to determine the position of the Earth relative to the Earth-Moon barycenter.
-     */
+    // Gets a point describing the motion of the Earth.  This point uses the Moon point and
+    // the 1992 mu value (ratio between Moon and Earth masses) in Table 2 of the paper in order
+    // to determine the position of the Earth relative to the Earth-Moon barycenter.
     var moonEarthMassRatio = 0.012300034; // From 1992 mu value in Table 2
     var factor = moonEarthMassRatio / (moonEarthMassRatio + 1.0) * -1;
     function computeSimonEarth(date, result) {

Source/Core/TimeIntervalCollection.js

@@ -462,7 +462,7 @@ define([
      * The data property of the input interval is ignored.
      *
      * @param {TimeInterval} interval The interval to remove.
-     * @returns <code>true</code> if the interval was removed, <code>false</code> if no part of the interval was in the collection.
+     * @returns {Boolean} <code>true</code> if the interval was removed, <code>false</code> if no part of the interval was in the collection.
      */
     TimeIntervalCollection.prototype.removeInterval = function(interval) {
         //>>includeStart('debug', pragmas.debug);

Source/Core/Transforms.js

@@ -48,6 +48,7 @@ define([
      * Contains functions for transforming positions to various reference frames.
      *
      * @exports Transforms
+     * @namespace
      */
     var Transforms = {};
 
@@ -536,7 +537,7 @@ define([
      * indicates that the preload has completed.
      *
      * @param {TimeInterval} timeInterval The interval to preload.
-     * @returns {Promise.<undefined>} A promise that, when resolved, indicates that the preload has completed
+     * @returns {Promise} A promise that, when resolved, indicates that the preload has completed
      *          and evaluation of the transformation between the fixed and ICRF axes will
      *          no longer return undefined for a time inside the interval.
      *

Source/Core/binarySearch.js

@@ -8,7 +8,6 @@ define([
      * Finds an item in a sorted array.
      *
      * @exports binarySearch
-     *
      * @param {Array} array The sorted array to search.
      * @param {*} itemToFind The item to find in the array.
      * @param {binarySearch~Comparator} comparator The function to use to compare the item to

Source/Core/mergeSort.js

@@ -57,7 +57,6 @@ define([
      * A stable merge sort.
      *
      * @exports mergeSort
-     *
      * @param {Array} array The array to sort.
      * @param {mergeSort~Comparator} comparator The function to use to compare elements in the array.
      * @param {*} [userDefinedObject] Any item to pass as the third parameter to <code>comparator</code>.

Source/Core/writeTextToCanvas.js

@@ -32,6 +32,7 @@ define([
      * @returns {Canvas} A new canvas with the given text drawn into it.  The dimensions object
      *                   from measureText will also be added to the returned canvas. If text is
      *                   blank, returns undefined.
+     * @exports writeTextToCanvas
      */
     function writeTextToCanvas(text, options) {
         //>>includeStart('debug', pragmas.debug);

Source/DataSources/GroundGeometryUpdater.js

@@ -41,7 +41,7 @@ define([
     /**
      * An abstract class for updating ground geometry entities.
      * @constructor
-     *
+     * @alias GroundGeometryUpdater
      * @param {Object} options An object with the following properties:
      * @param {Entity} options.entity The entity containing the geometry to be visualized.
      * @param {Scene} options.scene The scene where visualization is taking place.

Source/DataSources/KmlTour.js

@@ -106,26 +106,15 @@ define([
         cancelAllEntries(this._activeEntries);
     };
 
-    /**
-     * Stop all activeEntries.
-     * @param {Array} activeEntries
-     */
+    // Stop all activeEntries.
     function cancelAllEntries(activeEntries) {
         for(var entry = activeEntries.pop(); entry !== undefined; entry = activeEntries.pop()) {
             entry.stop();
         }
     }
 
-    /**
-     * Play playlist entry.
-     * This function is called recursevly with playNext
-     * and iterates over all entries from playlist.
-     *
-     * @param {ViewerWidget} viewer Cesium viewer.
-     * @param {Object} cameraOptions see {@link Camera#flyTo}.
-     * @param {Function} allDone a function will be called when all entries from playlist
-     * being played or user call {@link KmlTour#stop}.
-     */
+    // Play playlist entry.
+    // This function is called recursevly with playNext and iterates over all entries from playlist.
     function playEntry(viewer, cameraOptions, allDone) {
         var entry = this.playlist[this.playlistIndex];
         if (entry) {
@@ -152,16 +141,7 @@ define([
         }
     }
 
-    /**
-     * Increment playlistIndex and call playEntry
-     * if terminated isn't true.
-     *
-     * @param {ViewerWidget} viewer passed for recursion.
-     * @param {Object} cameraOptions passed for recursion.
-     * @param {Function} allDone passed for recursion.
-     * @param {Boolean} terminated true if active entry was terminated,
-     * and the whole tour should be terminated.
-     */
+    // Increment playlistIndex and call playEntry if terminated isn't true.
     function playNext(viewer, cameraOptions, allDone, terminated) {
         var entry = this.playlist[this.playlistIndex];
         this.entryEnd.raiseEvent(entry, terminated);

Source/Renderer/CubeMap.js

@@ -32,6 +32,9 @@ define([
         TextureMinificationFilter) {
     'use strict';
 
+    /**
+     * @private
+     */
     function CubeMap(options) {
         options = defaultValue(options, defaultValue.EMPTY_OBJECT);
 

Source/Renderer/Texture.js

@@ -36,6 +36,9 @@ define([
         TextureMinificationFilter) {
     'use strict';
 
+    /**
+     * @private
+    */
     function Texture(options) {
         options = defaultValue(options, defaultValue.EMPTY_OBJECT);