From 469847dc7cec7090cd0a7319db3a99673c30c9b6 Mon Sep 17 00:00:00 2001 From: Scott Hunter Date: Fri, 23 May 2014 13:39:19 -0400 Subject: [PATCH 1/2] Fix documentation. --- Source/Core/Cartesian2.js | 10 +++++----- Source/Core/Cartesian3.js | 10 +++++----- Source/Core/Cartesian4.js | 10 +++++----- Source/Core/Color.js | 4 ++-- Source/Core/EllipsoidalOccluder.js | 4 ++-- Source/Core/HermitePolynomialApproximation.js | 2 +- Source/Core/InterpolationAlgorithm.js | 2 +- Source/Core/LagrangePolynomialApproximation.js | 2 +- Source/Core/LinearApproximation.js | 2 +- Source/Core/Math.js | 4 ++-- Source/Core/Occluder.js | 6 +++--- Source/Core/PolygonPipeline.js | 6 +++--- Source/Core/Queue.js | 2 +- Source/Core/Rectangle.js | 2 +- Source/Core/TerrainProvider.js | 6 +++--- Source/DynamicScene/DynamicObject.js | 4 ++-- Source/DynamicScene/ReferenceProperty.js | 2 +- Source/Renderer/Context.js | 4 ++-- Source/Scene/Camera.js | 2 +- Source/Scene/CullingVolume.js | 2 +- Source/Scene/ImageryLayer.js | 2 +- Source/Scene/ImageryProvider.js | 2 +- .../Functions/latitudeToWebMercatorFraction.glsl | 8 ++++---- Source/Widgets/Animation/AnimationViewModel.js | 2 +- Source/Widgets/Viewer/Viewer.js | 4 ++-- 25 files changed, 52 insertions(+), 52 deletions(-) diff --git a/Source/Core/Cartesian2.js b/Source/Core/Cartesian2.js index 7b8438e137db..4b4d3382a5a4 100644 --- a/Source/Core/Cartesian2.js +++ b/Source/Core/Cartesian2.js @@ -184,7 +184,7 @@ define([ * Computes the value of the maximum component for the supplied Cartesian. * @memberof Cartesian2 * - * @param {Cartesian2} The cartesian to use. + * @param {Cartesian2} cartesian The cartesian to use. * @returns {Number} The value of the maximum component. */ Cartesian2.getMaximumComponent = function(cartesian) { @@ -201,7 +201,7 @@ define([ * Computes the value of the minimum component for the supplied Cartesian. * @memberof Cartesian2 * - * @param {Cartesian2} The cartesian to use. + * @param {Cartesian2} cartesian The cartesian to use. * @returns {Number} The value of the minimum component. */ Cartesian2.getMinimumComponent = function(cartesian) { @@ -556,9 +556,9 @@ define([ * Computes the linear interpolation or extrapolation at t using the provided cartesians. * @memberof Cartesian2 * - * @param start The value corresponding to t at 0.0. - * @param end The value corresponding to t at 1.0. - * @param t The point along t at which to interpolate. + * @param {Cartesian2} start The value corresponding to t at 0.0. + * @param {Cartesian2} end The value corresponding to t at 1.0. + * @param {Number} t The point along t at which to interpolate. * @param {Cartesian2} [result] The object onto which to store the result. * @returns {Cartesian2} The modified result parameter or a new Cartesian2 instance if one was not provided. */ diff --git a/Source/Core/Cartesian3.js b/Source/Core/Cartesian3.js index 058a8e722c06..ee2fa1d7f45d 100644 --- a/Source/Core/Cartesian3.js +++ b/Source/Core/Cartesian3.js @@ -215,7 +215,7 @@ define([ * Computes the value of the maximum component for the supplied Cartesian. * @memberof Cartesian3 * - * @param {Cartesian3} The cartesian to use. + * @param {Cartesian3} cartesian The cartesian to use. * @returns {Number} The value of the maximum component. */ Cartesian3.getMaximumComponent = function(cartesian) { @@ -232,7 +232,7 @@ define([ * Computes the value of the minimum component for the supplied Cartesian. * @memberof Cartesian3 * - * @param {Cartesian3} The cartesian to use. + * @param {Cartesian3} cartesian The cartesian to use. * @returns {Number} The value of the minimum component. */ Cartesian3.getMinimumComponent = function(cartesian) { @@ -597,9 +597,9 @@ define([ * Computes the linear interpolation or extrapolation at t using the provided cartesians. * @memberof Cartesian3 * - * @param start The value corresponding to t at 0.0. - * @param end The value corresponding to t at 1.0. - * @param t The point along t at which to interpolate. + * @param {Cartesian3} start The value corresponding to t at 0.0. + * @param {Cartesian3} end The value corresponding to t at 1.0. + * @param {Number} t The point along t at which to interpolate. * @param {Cartesian3} [result] The object onto which to store the result. * @returns {Cartesian3} The modified result parameter or a new Cartesian3 instance if one was not provided. */ diff --git a/Source/Core/Cartesian4.js b/Source/Core/Cartesian4.js index 32b7096b25a7..6702c6935ca2 100644 --- a/Source/Core/Cartesian4.js +++ b/Source/Core/Cartesian4.js @@ -217,7 +217,7 @@ define([ * Computes the value of the maximum component for the supplied Cartesian. * @memberof Cartesian4 * - * @param {Cartesian4} The cartesian to use. + * @param {Cartesian4} cartesian The cartesian to use. * @returns {Number} The value of the maximum component. */ Cartesian4.getMaximumComponent = function(cartesian) { @@ -234,7 +234,7 @@ define([ * Computes the value of the minimum component for the supplied Cartesian. * @memberof Cartesian4 * - * @param {Cartesian4} The cartesian to use. + * @param {Cartesian4} cartesian The cartesian to use. * @returns {Number} The value of the minimum component. */ Cartesian4.getMinimumComponent = function(cartesian) { @@ -610,9 +610,9 @@ define([ * Computes the linear interpolation or extrapolation at t using the provided cartesians. * @memberof Cartesian4 * - * @param start The value corresponding to t at 0.0. - * @param end The value corresponding to t at 1.0. - * @param t The point along t at which to interpolate. + * @param {Cartesian4} start The value corresponding to t at 0.0. + * @param {Cartesian4}end The value corresponding to t at 1.0. + * @param {Number} t The point along t at which to interpolate. * @param {Cartesian4} [result] The object onto which to store the result. * @returns {Cartesian4} The modified result parameter or a new Cartesian4 instance if one was not provided. */ diff --git a/Source/Core/Color.js b/Source/Core/Color.js index a9aed8afede3..b83ff1cb132c 100644 --- a/Source/Core/Color.js +++ b/Source/Core/Color.js @@ -434,7 +434,7 @@ define([ * @memberof Color * * @param {Number} number The number to be converted. - * @returns {number} The converted number. + * @returns {Number} The converted number. */ Color.byteToFloat = function(number) { return number / 255.0; @@ -446,7 +446,7 @@ define([ * @memberof Color * * @param {Number} number The number to be converted. - * @returns {number} The converted number. + * @returns {Number} The converted number. */ Color.floatToByte = function(number) { return number === 1.0 ? 255.0 : (number * 256.0) | 0; diff --git a/Source/Core/EllipsoidalOccluder.js b/Source/Core/EllipsoidalOccluder.js index 73a53f581e45..b4951ce694c2 100644 --- a/Source/Core/EllipsoidalOccluder.js +++ b/Source/Core/EllipsoidalOccluder.js @@ -98,7 +98,7 @@ define([ * * @param {Cartesian3} occludee The point to test for visibility. * - * @returns {boolean} true if the occludee is visible; otherwise false. + * @returns {Boolean} true if the occludee is visible; otherwise false. * * @example * var cameraPosition = new Cesium.Cartesian3(0, 0, 2.5); @@ -122,7 +122,7 @@ define([ * * @param {Cartesian3} occludeeScaledSpacePosition The point to test for visibility, represented in the scaled space. * - * @returns {boolean} true if the occludee is visible; otherwise false. + * @returns {Boolean} true if the occludee is visible; otherwise false. * * @example * var cameraPosition = new Cesium.Cartesian3(0, 0, 2.5); diff --git a/Source/Core/HermitePolynomialApproximation.js b/Source/Core/HermitePolynomialApproximation.js index 2a5b1ddeb22b..aedf65ef4e46 100644 --- a/Source/Core/HermitePolynomialApproximation.js +++ b/Source/Core/HermitePolynomialApproximation.js @@ -67,7 +67,7 @@ define([ * * @memberof HermitePolynomialApproximation * - * @param degree The desired degree of interpolation. + * @param {Number} degree The desired degree of interpolation. * * @returns The number of required data points needed for the desired degree of interpolation. */ diff --git a/Source/Core/InterpolationAlgorithm.js b/Source/Core/InterpolationAlgorithm.js index 5c9ea131e9e2..a2ebf519ebef 100644 --- a/Source/Core/InterpolationAlgorithm.js +++ b/Source/Core/InterpolationAlgorithm.js @@ -25,7 +25,7 @@ define([ * Given the desired degree, returns the number of data points required for interpolation. * @memberof InterpolationAlgorithm * - * @param degree The desired degree of interpolation. + * @param {Number} degree The desired degree of interpolation. * * @returns The number of required data points needed for the desired degree of interpolation. */ diff --git a/Source/Core/LagrangePolynomialApproximation.js b/Source/Core/LagrangePolynomialApproximation.js index 8f1ce61e45a2..530e36d31489 100644 --- a/Source/Core/LagrangePolynomialApproximation.js +++ b/Source/Core/LagrangePolynomialApproximation.js @@ -21,7 +21,7 @@ define([ * * @memberof LagrangePolynomialApproximation * - * @param degree The desired degree of interpolation. + * @param {Number} degree The desired degree of interpolation. * * @returns The number of required data points needed for the desired degree of interpolation. */ diff --git a/Source/Core/LinearApproximation.js b/Source/Core/LinearApproximation.js index e0709a07b139..17c2688dc90d 100644 --- a/Source/Core/LinearApproximation.js +++ b/Source/Core/LinearApproximation.js @@ -24,7 +24,7 @@ define([ * * @memberof LinearApproximation * - * @param degree The desired degree of interpolation. + * @param {Number} degree The desired degree of interpolation. * * @exception {DeveloperError} Linear interpolation can only generate a first degree polynomial. * diff --git a/Source/Core/Math.js b/Source/Core/Math.js index b31562a4def6..7a3b0344cb15 100644 --- a/Source/Core/Math.js +++ b/Source/Core/Math.js @@ -224,7 +224,7 @@ define([ * *

* - * @param value The number whose hyperbolic sine is to be returned. + * @param {Number} value The number whose hyperbolic sine is to be returned. * * @returns The hyperbolic sine of {@code value}. */ @@ -251,7 +251,7 @@ define([ * *

* - * @param value The number whose hyperbolic cosine is to be returned. + * @param {Number} value The number whose hyperbolic cosine is to be returned. * * @returns The hyperbolic cosine of {@code value}. */ diff --git a/Source/Core/Occluder.js b/Source/Core/Occluder.js index 65e4b25af804..9bd6e09d5af8 100644 --- a/Source/Core/Occluder.js +++ b/Source/Core/Occluder.js @@ -167,7 +167,7 @@ define([ * * @param {Cartesian3} occludee The point surrounding the occludee object. * - * @returns {boolean} true if the occludee is visible; otherwise false. + * @returns {Boolean} true if the occludee is visible; otherwise false. * * @example * var cameraPosition = new Cesium.Cartesian3(0, 0, 0); @@ -201,7 +201,7 @@ define([ * * @param {BoundingSphere} occludee The bounding sphere surrounding the occludee object. * - * @returns {boolean} true if the occludee is visible; otherwise false. + * @returns {Boolean} true if the occludee is visible; otherwise false. * * @example * var cameraPosition = new Cesium.Cartesian3(0, 0, 0); @@ -522,4 +522,4 @@ define([ }; return Occluder; -}); \ No newline at end of file +}); diff --git a/Source/Core/PolygonPipeline.js b/Source/Core/PolygonPipeline.js index 599ac608e5c8..4f8d72c7ef1e 100644 --- a/Source/Core/PolygonPipeline.js +++ b/Source/Core/PolygonPipeline.js @@ -687,9 +687,9 @@ define([ * Do not include number === n1 or number === n2. * Do include n1 === n2 === number. * - * @param {number} number The number tested. - * @param {number} n1 First bound. - * @param {number} n2 Secound bound. + * @param {Number} number The number tested. + * @param {Number} n1 First bound. + * @param {Number} n2 Secound bound. * @returns {Boolean} number is between n1 and n2. * * @private diff --git a/Source/Core/Queue.js b/Source/Core/Queue.js index 7fde6923d350..652bd40f5f86 100644 --- a/Source/Core/Queue.js +++ b/Source/Core/Queue.js @@ -60,7 +60,7 @@ define(function() { /** * Check whether this queue contains the specified item. * - * @param {Object} the item to search for. + * @param {Object} item the item to search for. * @memberof Queue */ Queue.prototype.contains = function(item) { diff --git a/Source/Core/Rectangle.js b/Source/Core/Rectangle.js index 7b4e7475f1ee..0a2bf3ebe201 100644 --- a/Source/Core/Rectangle.js +++ b/Source/Core/Rectangle.js @@ -470,7 +470,7 @@ define([ * @memberof Rectangle * * @param {Rectangle} rectangle On rectangle to find an intersection - * @param otherRectangle Another rectangle to find an intersection + * @param {Rectangle} otherRectangle Another rectangle to find an intersection * @param {Rectangle} [result] The object onto which to store the result. * @returns {Rectangle} The modified result parameter or a new Rectangle instance if none was provided. */ diff --git a/Source/Core/TerrainProvider.js b/Source/Core/TerrainProvider.js index c88e78716cb6..8465ac158651 100644 --- a/Source/Core/TerrainProvider.js +++ b/Source/Core/TerrainProvider.js @@ -135,9 +135,9 @@ define([ /** * Determines an appropriate geometric error estimate when the geometry comes from a heightmap. * - * @param ellipsoid The ellipsoid to which the terrain is attached. - * @param tileImageWidth The width, in pixels, of the heightmap associated with a single tile. - * @param numberOfTilesAtLevelZero The number of tiles in the horizontal direction at tile level zero. + * @param {Ellipsoid} ellipsoid The ellipsoid to which the terrain is attached. + * @param {Number} tileImageWidth The width, in pixels, of the heightmap associated with a single tile. + * @param {Number} numberOfTilesAtLevelZero The number of tiles in the horizontal direction at tile level zero. * @returns {Number} An estimated geometric error. */ TerrainProvider.getEstimatedLevelZeroGeometricErrorForAHeightmap = function(ellipsoid, tileImageWidth, numberOfTilesAtLevelZero) { diff --git a/Source/DynamicScene/DynamicObject.js b/Source/DynamicScene/DynamicObject.js index fb558d66edb6..fe22a20a4416 100644 --- a/Source/DynamicScene/DynamicObject.js +++ b/Source/DynamicScene/DynamicObject.js @@ -290,7 +290,7 @@ define([ * with {@link CompositeDynamicObjectCollection} * @memberof DynamicObject * - * @param propertyName The name of the property to add. + * @param {String} propertyName The name of the property to add. * * @exception {DeveloperError} "propertyName" is a reserved property name. * @exception {DeveloperError} "propertyName" is already a registered property. @@ -318,7 +318,7 @@ define([ * Removed a property previously added with addProperty. * @memberof DynamicObject * - * @param propertyName The name of the property to remove. + * @param {String} propertyName The name of the property to remove. * * @exception {DeveloperError} "propertyName" is a reserved property name. * @exception {DeveloperError} "propertyName" is not a registered property. diff --git a/Source/DynamicScene/ReferenceProperty.js b/Source/DynamicScene/ReferenceProperty.js index bc756adb03d3..8fa52850117d 100644 --- a/Source/DynamicScene/ReferenceProperty.js +++ b/Source/DynamicScene/ReferenceProperty.js @@ -90,7 +90,7 @@ define([ * delineated by a period. * * @param {DynamicObject} dynamicObjectCollection - * @param referenceString + * @param {String} referenceString * * @returns A new instance of ReferenceProperty. * diff --git a/Source/Renderer/Context.js b/Source/Renderer/Context.js index 9cbb720427e6..27b890d9cda8 100644 --- a/Source/Renderer/Context.js +++ b/Source/Renderer/Context.js @@ -2274,7 +2274,7 @@ define([ * * @memberof Context * - * @param {Color} The pick color. + * @param {Color} pickColor The pick color. * * @returns {Object} The object associated with the pick color, or undefined if no object is associated with that color. * @@ -2380,4 +2380,4 @@ define([ }; return Context; -}); \ No newline at end of file +}); diff --git a/Source/Scene/Camera.js b/Source/Scene/Camera.js index 7727089cfa45..33ee93e6cde2 100644 --- a/Source/Scene/Camera.js +++ b/Source/Scene/Camera.js @@ -716,7 +716,7 @@ define([ * * @memberof Camera * - * @param {Matrix4} The camera transform. + * @param {Matrix4} transform The camera transform. */ Camera.prototype.setTransform = function(transform) { var position = Cartesian3.clone(this.positionWC, setTransformPosition); diff --git a/Source/Scene/CullingVolume.js b/Source/Scene/CullingVolume.js index c31dd87c32d7..280d8714b837 100644 --- a/Source/Scene/CullingVolume.js +++ b/Source/Scene/CullingVolume.js @@ -17,7 +17,7 @@ define([ * @alias CullingVolume * @constructor * - * @param Array planes An array of clipping planes. + * @param {Cartesian4[]} planes An array of clipping planes. */ var CullingVolume = function(planes) { /** diff --git a/Source/Scene/ImageryLayer.js b/Source/Scene/ImageryLayer.js index 8cea2cb82dbc..39122bd15438 100644 --- a/Source/Scene/ImageryLayer.js +++ b/Source/Scene/ImageryLayer.js @@ -283,7 +283,7 @@ define([ /** * This value is used as the default brightness for the imagery layer if one is not provided during construction * or by the imagery provider. This value does not modify the brightness of the imagery. - * @type {number} + * @type {Number} * @default 1.0 */ ImageryLayer.DEFAULT_BRIGHTNESS = 1.0; diff --git a/Source/Scene/ImageryProvider.js b/Source/Scene/ImageryProvider.js index d47dc1adc24f..57ef0df92ae3 100644 --- a/Source/Scene/ImageryProvider.js +++ b/Source/Scene/ImageryProvider.js @@ -292,7 +292,7 @@ define([ * that the request should be retried later. * @memberof ImageryProvider * - * @param url {String} The URL of the image. + * @param {String} url The URL of the image. * @returns {Promise} A promise for the image that will resolve when the image is available, or * undefined if there are too many active requests to the server, and the request * should be retried later. The resolved image may be either an diff --git a/Source/Shaders/Builtin/Functions/latitudeToWebMercatorFraction.glsl b/Source/Shaders/Builtin/Functions/latitudeToWebMercatorFraction.glsl index d52013f95768..2a76d5689e61 100644 --- a/Source/Shaders/Builtin/Functions/latitudeToWebMercatorFraction.glsl +++ b/Source/Shaders/Builtin/Functions/latitudeToWebMercatorFraction.glsl @@ -4,10 +4,10 @@ * @name czm_latitudeToWebMercatorFraction * @glslFunction * - * @param {float} The geodetic latitude, in radians. - * @param {float} The low portion of the Web Mercator coordinate of the southern boundary of the rectangle. - * @param {float} The high portion of the Web Mercator coordinate of the southern boundary of the rectangle. - * @param {float} The total height of the rectangle in Web Mercator coordinates. + * @param {float} latitude The geodetic latitude, in radians. + * @param {float} southMercatorYLow The low portion of the Web Mercator coordinate of the southern boundary of the rectangle. + * @param {float} southMercatorYHigh The high portion of the Web Mercator coordinate of the southern boundary of the rectangle. + * @param {float} oneOverMercatorHeight The total height of the rectangle in Web Mercator coordinates. * * @returns {float} The fraction of the rectangle at which the latitude occurs. If the latitude is the southern * boundary of the rectangle, the return value will be zero. If it is the northern boundary, the return diff --git a/Source/Widgets/Animation/AnimationViewModel.js b/Source/Widgets/Animation/AnimationViewModel.js index 5d4e45ddb35f..a3b5b54e297d 100644 --- a/Source/Widgets/Animation/AnimationViewModel.js +++ b/Source/Widgets/Animation/AnimationViewModel.js @@ -419,7 +419,7 @@ define([ * automatically, and duplicate values will be removed. * @memberof AnimationViewModel * - * @param positiveTicks The list of known positive clock multipliers to associate with the shuttle ring. + * @param {Number[]} positiveTicks The list of known positive clock multipliers to associate with the shuttle ring. */ AnimationViewModel.prototype.setShuttleRingTicks = function(positiveTicks) { //>>includeStart('debug', pragmas.debug); diff --git a/Source/Widgets/Viewer/Viewer.js b/Source/Widgets/Viewer/Viewer.js index 2eab48243763..e98a4d04722c 100644 --- a/Source/Widgets/Viewer/Viewer.js +++ b/Source/Widgets/Viewer/Viewer.js @@ -727,8 +727,8 @@ Either specify options.terrainProvider instead or set options.baseLayerPicker to * to the provided viewer instance. * @memberof Viewer * - * @param mixin The Viewer mixin to add to this instance. - * @param options The options object to be passed to the mixin function. + * @param {Function} mixin The Viewer mixin to add to this instance. + * @param {Object} options The options object to be passed to the mixin function. * * @see viewerDragDropMixin * @see viewerDynamicObjectMixin From cb4406575f5fe03c40e5caf17e799747bfc2b47c Mon Sep 17 00:00:00 2001 From: Scott Hunter Date: Fri, 23 May 2014 16:22:15 -0400 Subject: [PATCH 2/2] Documentation fixes. --- Source/Core/AxisAlignedBoundingBox.js | 18 +++++++++-------- Source/Core/BoundingSphere.js | 20 ++++++++++--------- Source/Core/Cartesian2.js | 2 +- Source/Core/Cartesian3.js | 18 ++++++++--------- Source/Core/Cartesian4.js | 2 +- Source/Core/CircleOutlineGeometry.js | 2 +- Source/Core/ClockRange.js | 3 --- Source/Core/ClockStep.js | 3 --- Source/Core/Color.js | 2 +- Source/Core/CornerType.js | 3 --- Source/Core/CorridorGeometry.js | 4 ++-- Source/Core/CorridorOutlineGeometry.js | 4 ++-- Source/Core/CylinderGeometry.js | 2 +- Source/Core/CylinderOutlineGeometry.js | 4 ++-- Source/Core/EllipseOutlineGeometry.js | 2 +- Source/Core/Intersect.js | 3 --- Source/Core/JulianDate.js | 6 +++--- Source/Core/KeyboardEventModifier.js | 3 --- Source/Core/Matrix4.js | 6 +++--- Source/Core/NearFarScalar.js | 2 +- Source/Core/Packable.js | 2 +- Source/Core/PackableForInterpolation.js | 2 +- Source/Core/PolylinePipeline.js | 6 +++--- Source/Core/PolylineVolumeGeometry.js | 2 +- Source/Core/PolylineVolumeOutlineGeometry.js | 6 +++--- Source/Core/Quaternion.js | 4 ++-- Source/Core/Rectangle.js | 2 +- Source/Core/ReferenceFrame.js | 3 +-- Source/Core/ScreenSpaceEventType.js | 17 ---------------- Source/Core/TimeConstants.js | 1 - Source/Core/Visibility.js | 5 ++--- .../DynamicScene/ConstantPositionProperty.js | 2 +- Source/DynamicScene/PositionProperty.js | 2 +- Source/DynamicScene/PositionPropertyArray.js | 2 +- .../DynamicScene/SampledPositionProperty.js | 2 +- .../TimeIntervalCollectionPositionProperty.js | 2 +- Source/Renderer/Context.js | 4 ++-- Source/Renderer/Texture.js | 4 ++-- Source/Scene/Camera.js | 2 +- Source/Scene/CameraEventType.js | 5 ----- Source/Scene/HorizontalOrigin.js | 5 ++--- Source/Scene/LabelStyle.js | 3 --- Source/Scene/ModelAnimationLoop.js | 3 --- Source/Scene/OrthographicFrustum.js | 2 +- Source/Scene/PerspectiveFrustum.js | 2 +- Source/Scene/PerspectiveOffCenterFrustum.js | 2 +- Source/Scene/Scene.js | 6 +++--- Source/Scene/SceneMode.js | 16 ++++++--------- Source/Scene/VerticalOrigin.js | 5 ++--- .../SelectionIndicatorViewModel.js | 4 ++-- 50 files changed, 92 insertions(+), 140 deletions(-) diff --git a/Source/Core/AxisAlignedBoundingBox.js b/Source/Core/AxisAlignedBoundingBox.js index 7f57fe9880ed..51150c357201 100644 --- a/Source/Core/AxisAlignedBoundingBox.js +++ b/Source/Core/AxisAlignedBoundingBox.js @@ -167,10 +167,11 @@ define([ * @param {AxisAlignedBoundingBox} box The bounding box to test. * @param {Cartesian4} plane The coefficients of the plane in the form ax + by + cz + d = 0 * where the coefficients a, b, c, and d are the components x, y, z, and w - * of the {Cartesian4}, respectively. - * @returns {Intersect} {Intersect.INSIDE} if the entire box is on the side of the plane the normal is pointing, - * {Intersect.OUTSIDE} if the entire box is on the opposite side, and {Intersect.INTERSETING} - * if the box intersects the plane. + * of the {@link Cartesian4}, respectively. + * @returns {Intersect} {@link Intersect.INSIDE} if the entire box is on the side of the plane + * the normal is pointing, {@link Intersect.OUTSIDE} if the entire box is + * on the opposite side, and {@link Intersect.INTERSECTING} if the box + * intersects the plane. */ AxisAlignedBoundingBox.intersect = function(box, plane) { //>>includeStart('debug', pragmas.debug); @@ -216,10 +217,11 @@ define([ * * @param {Cartesian4} plane The coefficients of the plane in the form ax + by + cz + d = 0 * where the coefficients a, b, c, and d are the components x, y, z, and w - * of the {Cartesian4}, respectively. - * @returns {Intersect} {Intersect.INSIDE} if the entire box is on the side of the plane the normal is pointing, - * {Intersect.OUTSIDE} if the entire box is on the opposite side, and {Intersect.INTERSETING} - * if the box intersects the plane. + * of the {@link Cartesian4}, respectively. + * @returns {Intersect} {@link Intersect.INSIDE} if the entire box is on the side of the plane + * the normal is pointing, {@link Intersect.OUTSIDE} if the entire box is + * on the opposite side, and {@link Intersect.INTERSECTING} if the box + * intersects the plane. */ AxisAlignedBoundingBox.prototype.intersect = function(plane) { return AxisAlignedBoundingBox.intersect(this, plane); diff --git a/Source/Core/BoundingSphere.js b/Source/Core/BoundingSphere.js index 531fd418a9db..c37e666d2a31 100644 --- a/Source/Core/BoundingSphere.js +++ b/Source/Core/BoundingSphere.js @@ -577,7 +577,7 @@ define([ /** * The number of elements used to pack the object into an array. - * @Type {Number} + * @type {Number} */ BoundingSphere.packedLength = 4; @@ -717,10 +717,11 @@ define([ * @param {BoundingSphere} sphere The bounding sphere to test. * @param {Cartesian4} plane The coefficients of the plane in the for ax + by + cz + d = 0 * where the coefficients a, b, c, and d are the components x, y, z, - * and w of the {Cartesian4}, respectively. - * @returns {Intersect} {Intersect.INSIDE} if the entire sphere is on the side of the plane the normal - * is pointing, {Intersect.OUTSIDE} if the entire sphere is on the opposite side, - * and {Intersect.INTERSETING} if the sphere intersects the plane. + * and w of the {@link Cartesian4}, respectively. + * @returns {Intersect} {@link Intersect.INSIDE} if the entire sphere is on the side of the plane + * the normal is pointing, {@link Intersect.OUTSIDE} if the entire sphere is + * on the opposite side, and {@link Intersect.INTERSECTING} if the sphere + * intersects the plane. */ BoundingSphere.intersect = function(sphere, plane) { //>>includeStart('debug', pragmas.debug); @@ -1022,10 +1023,11 @@ define([ * * @param {Cartesian4} plane The coefficients of the plane in the for ax + by + cz + d = 0 * where the coefficients a, b, c, and d are the components x, y, z, - * and w of the {Cartesian4}, respectively. - * @returns {Intersect} {Intersect.INSIDE} if the entire sphere is on the side of the plane the normal - * is pointing, {Intersect.OUTSIDE} if the entire sphere is on the opposite side, - * and {Intersect.INTERSETING} if the sphere intersects the plane. + * and w of the {@link Cartesian4}, respectively. + * @returns {Intersect} {@link Intersect.INSIDE} if the entire sphere is on the side of the plane + * the normal is pointing, {@link Intersect.OUTSIDE} if the entire sphere is + * on the opposite side, and {@link Intersect.INTERSECTING} if the sphere + * intersects the plane. */ BoundingSphere.prototype.intersect = function(plane) { return BoundingSphere.intersect(this, plane); diff --git a/Source/Core/Cartesian2.js b/Source/Core/Cartesian2.js index 4b4d3382a5a4..f856eaf0c600 100644 --- a/Source/Core/Cartesian2.js +++ b/Source/Core/Cartesian2.js @@ -105,7 +105,7 @@ define([ /** * The number of elements used to pack the object into an array. - * @Type {Number} + * @type {Number} */ Cartesian2.packedLength = 2; diff --git a/Source/Core/Cartesian3.js b/Source/Core/Cartesian3.js index ee2fa1d7f45d..e337b0ab47ad 100644 --- a/Source/Core/Cartesian3.js +++ b/Source/Core/Cartesian3.js @@ -134,7 +134,7 @@ define([ /** * The number of elements used to pack the object into an array. - * @Type {Number} + * @type {Number} */ Cartesian3.packedLength = 3; @@ -773,8 +773,8 @@ define([ * * @param {Number} longitude The longitude, in degrees * @param {Number} latitude The latitude, in degrees - * @param {Number} [height = 0] The height, in meters, above the ellipsoid. - * @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the position lies. + * @param {Number} [height=0.0] The height, in meters, above the ellipsoid. + * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the position lies. * @param {Cartesian3} [result] The object onto which to store the result. * * @returns {Cartesian3} The position @@ -807,8 +807,8 @@ define([ * * @param {Number} longitude The longitude, in radians * @param {Number} latitude The latitude, in radians - * @param {Number} [height = 0] The height, in meters, above the ellipsoid. - * @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the position lies. + * @param {Number} [height=0.0] The height, in meters, above the ellipsoid. + * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the position lies. * @param {Cartesian3} [result] The object onto which to store the result. * * @returns {Cartesian3} The position @@ -847,7 +847,7 @@ define([ * @memberof Cartesian3 * * @param {Number[]} coordinates A list of longitude and latitude values. Values alternate [longitude, latitude, longitude, latitude...]. - * @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the coordinates lie. + * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the coordinates lie. * @param {Cartesian3[]} [result] An array of Cartesian3 objects to store the result. * * @returns {Cartesian3[]} The array of positions. @@ -875,7 +875,7 @@ define([ * @memberof Cartesian3 * * @param {Number[]} coordinates A list of longitude and latitude values. Values alternate [longitude, latitude, longitude, latitude...]. - * @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the coordinates lie. + * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the coordinates lie. * @param {Cartesian3[]} [result] An array of Cartesian3 objects to store the result. * * @returns {Cartesian3[]} The array of positions. @@ -917,7 +917,7 @@ define([ * @memberof Cartesian3 * * @param {Number[]} coordinates A list of longitude, latitude and height values. Values alternate [longitude, latitude, height,, longitude, latitude, height...]. - * @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the position lies. + * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the position lies. * @param {Cartesian3[]} [result] An array of Cartesian3 objects to store the result. * * @returns {Cartesian3[]} The array of positions. @@ -953,7 +953,7 @@ define([ * @memberof Cartesian3 * * @param {Number[]} coordinates A list of longitude, latitude and height values. Values alternate [longitude, latitude, height,, longitude, latitude, height...]. - * @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the position lies. + * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the position lies. * @param {Cartesian3[]} [result] An array of Cartesian3 objects to store the result. * * @returns {Cartesian3[]} The array of positions. diff --git a/Source/Core/Cartesian4.js b/Source/Core/Cartesian4.js index 6702c6935ca2..688038ef3bcf 100644 --- a/Source/Core/Cartesian4.js +++ b/Source/Core/Cartesian4.js @@ -132,7 +132,7 @@ define([ /** * The number of elements used to pack the object into an array. - * @Type {Number} + * @type {Number} */ Cartesian4.packedLength = 4; diff --git a/Source/Core/CircleOutlineGeometry.js b/Source/Core/CircleOutlineGeometry.js index 48332590c50a..95f3a00c4d67 100644 --- a/Source/Core/CircleOutlineGeometry.js +++ b/Source/Core/CircleOutlineGeometry.js @@ -23,7 +23,7 @@ define([ * @param {Number} [options.height=0.0] The height above the ellipsoid. * @param {Number} [options.granularity=0.02] The angular distance between points on the circle in radians. * @param {Number} [options.extrudedHeight=0.0] The height of the extrusion relative to the ellipsoid. - * @param {Number} [options.numberOfVerticalLines = 16] Number of lines to draw between the top and bottom of an extruded circle. + * @param {Number} [options.numberOfVerticalLines=16] Number of lines to draw between the top and bottom of an extruded circle. * * @exception {DeveloperError} radius must be greater than zero. * @exception {DeveloperError} granularity must be greater than zero. diff --git a/Source/Core/ClockRange.js b/Source/Core/ClockRange.js index 0ab478ef97f9..12915069bdf4 100644 --- a/Source/Core/ClockRange.js +++ b/Source/Core/ClockRange.js @@ -17,7 +17,6 @@ define(function() { * * @type {Number} * @constant - * @default 0 */ UNBOUNDED : 0, @@ -27,7 +26,6 @@ define(function() { * * @type {Number} * @constant - * @default 1 */ CLAMPED : 1, @@ -39,7 +37,6 @@ define(function() { * * @type {Number} * @constant - * @default 2 */ LOOP_STOP : 2 }; diff --git a/Source/Core/ClockStep.js b/Source/Core/ClockStep.js index 49f3ef3d464e..b81e7feb119c 100644 --- a/Source/Core/ClockStep.js +++ b/Source/Core/ClockStep.js @@ -18,7 +18,6 @@ define(function() { * * @type {Number} * @constant - * @default 0 */ TICK_DEPENDENT : 0, @@ -28,7 +27,6 @@ define(function() { * * @type {Number} * @constant - * @default 1 */ SYSTEM_CLOCK_MULTIPLIER : 1, @@ -38,7 +36,6 @@ define(function() { * * @type {Number} * @constant - * @default 2 */ SYSTEM_CLOCK : 2 }; diff --git a/Source/Core/Color.js b/Source/Core/Color.js index b83ff1cb132c..8a74594ff34d 100644 --- a/Source/Core/Color.js +++ b/Source/Core/Color.js @@ -373,7 +373,7 @@ define([ /** * The number of elements used to pack the object into an array. - * @Type {Number} + * @type {Number} */ Color.packedLength = 4; diff --git a/Source/Core/CornerType.js b/Source/Core/CornerType.js index f529fcaf1d1a..906d696d5d10 100644 --- a/Source/Core/CornerType.js +++ b/Source/Core/CornerType.js @@ -14,7 +14,6 @@ define(function() { * Corner is circular. * @type {Number} * @constant - * @default 0 */ ROUNDED : 0, @@ -26,7 +25,6 @@ define(function() { * Corner point is the intersection of adjacent edges. * @type {Number} * @constant - * @default 1 */ MITERED : 1, @@ -38,7 +36,6 @@ define(function() { * Corner is clipped. * @type {Number} * @constant - * @default 2 */ BEVELED : 2 }; diff --git a/Source/Core/CorridorGeometry.js b/Source/Core/CorridorGeometry.js index 8beecd57771c..6f976942cad4 100644 --- a/Source/Core/CorridorGeometry.js +++ b/Source/Core/CorridorGeometry.js @@ -626,14 +626,14 @@ define([ * @alias CorridorGeometry * @constructor * - * @param {Cartesian3[]} options.positions An array of {Cartesain3} positions that define the center of the corridor. + * @param {Cartesian3[]} options.positions An array of positions that define the center of the corridor. * @param {Number} options.width The distance between the edges of the corridor in meters. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference. * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. * @param {Number} [options.height=0] The distance in meters between the ellipsoid surface and the positions. * @param {Number} [options.extrudedHeight] The distance in meters between the ellipsoid surface and the extrusion. * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. - * @param {Boolean} [options.cornerType = CornerType.ROUNDED] Determines the style of the corners. + * @param {Boolean} [options.cornerType=CornerType.ROUNDED] Determines the style of the corners. * * @see CorridorGeometry.createGeometry * diff --git a/Source/Core/CorridorOutlineGeometry.js b/Source/Core/CorridorOutlineGeometry.js index 2778e23127e6..3e55920c673f 100644 --- a/Source/Core/CorridorOutlineGeometry.js +++ b/Source/Core/CorridorOutlineGeometry.js @@ -306,13 +306,13 @@ define([ * @alias CorridorOutlineGeometry * @constructor * - * @param {Cartesian3[]} options.positions An array of {Cartesain3} positions that define the center of the corridor outline. + * @param {Cartesian3[]} options.positions An array of positions that define the center of the corridor outline. * @param {Number} options.width The distance between the edges of the corridor outline. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference. * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. * @param {Number} [options.height=0] The distance between the ellipsoid surface and the positions. * @param {Number} [options.extrudedHeight] The distance between the ellipsoid surface and the extrusion. - * @param {Boolean} [options.cornerType = CornerType.ROUNDED] Determines the style of the corners. + * @param {Boolean} [options.cornerType=CornerType.ROUNDED] Determines the style of the corners. * * @see CorridorOutlineGeometry.createGeometry * diff --git a/Source/Core/CylinderGeometry.js b/Source/Core/CylinderGeometry.js index 30e5add07d93..c557224e56d6 100644 --- a/Source/Core/CylinderGeometry.js +++ b/Source/Core/CylinderGeometry.js @@ -49,7 +49,7 @@ define([ * @param {Number} options.length The length of the cylinder. * @param {Number} options.topRadius The radius of the top of the cylinder. * @param {Number} options.bottomRadius The radius of the bottom of the cylinder. - * @param {Number} [options.slices = 128] The number of edges around perimeter of the cylinder. + * @param {Number} [options.slices=128] The number of edges around perimeter of the cylinder. * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. * * @exception {DeveloperError} options.length must be greater than 0. diff --git a/Source/Core/CylinderOutlineGeometry.js b/Source/Core/CylinderOutlineGeometry.js index a1bf5f1d5fa5..f5cae1fd01a5 100644 --- a/Source/Core/CylinderOutlineGeometry.js +++ b/Source/Core/CylinderOutlineGeometry.js @@ -40,8 +40,8 @@ define([ * @param {Number} options.length The length of the cylinder. * @param {Number} options.topRadius The radius of the top of the cylinder. * @param {Number} options.bottomRadius The radius of the bottom of the cylinder. - * @param {Number} [options.slices = 128] The number of edges around perimeter of the cylinder. - * @param {Number} [options.numberOfVerticalLines = 16] Number of lines to draw between the top and bottom surfaces of the cylinder. + * @param {Number} [options.slices=128] The number of edges around perimeter of the cylinder. + * @param {Number} [options.numberOfVerticalLines=16] Number of lines to draw between the top and bottom surfaces of the cylinder. * * @exception {DeveloperError} options.length must be greater than 0. * @exception {DeveloperError} options.topRadius must be greater than 0. diff --git a/Source/Core/EllipseOutlineGeometry.js b/Source/Core/EllipseOutlineGeometry.js index 99e891181baa..46e088b5c479 100644 --- a/Source/Core/EllipseOutlineGeometry.js +++ b/Source/Core/EllipseOutlineGeometry.js @@ -147,7 +147,7 @@ define([ * @param {Number} [options.extrudedHeight] The height of the extrusion. * @param {Number} [options.rotation=0.0] The angle from north (clockwise) in radians. The default is zero. * @param {Number} [options.granularity=0.02] The angular distance between points on the ellipse in radians. - * @param {Number} [options.numberOfVerticalLines = 16] Number of lines to draw between the top and bottom surface of an extruded ellipse. + * @param {Number} [options.numberOfVerticalLines=16] Number of lines to draw between the top and bottom surface of an extruded ellipse. * * @exception {DeveloperError} semiMajorAxis and semiMinorAxis must be greater than zero. * @exception {DeveloperError} semiMajorAxis must be larger than the semiMajorAxis. diff --git a/Source/Core/Intersect.js b/Source/Core/Intersect.js index 186d2611388f..81823945911b 100644 --- a/Source/Core/Intersect.js +++ b/Source/Core/Intersect.js @@ -16,7 +16,6 @@ define(function() { * * @type {Number} * @constant - * @default -1 */ OUTSIDE : -1, @@ -25,7 +24,6 @@ define(function() { * * @type {Number} * @constant - * @default 0 */ INTERSECTING : 0, @@ -34,7 +32,6 @@ define(function() { * * @type {Number} * @constant - * @default 1 */ INSIDE : 1 }; diff --git a/Source/Core/JulianDate.js b/Source/Core/JulianDate.js index ade534879f22..a2f3b31fc52b 100644 --- a/Source/Core/JulianDate.js +++ b/Source/Core/JulianDate.js @@ -230,7 +230,7 @@ define([ * * @param {Number} julianDayNumber The Julian Day Number representing the number of whole days. Fractional days will also be handled correctly. * @param {Number} julianSecondsOfDay The number of seconds into the current Julian Day Number. Fractional seconds, negative seconds and seconds greater than a day will be handled correctly. - * @param {TimeStandard} [timeStandard = TimeStandard.UTC] The time standard in which the first two parameters are defined. + * @param {TimeStandard} [timeStandard=TimeStandard.UTC] The time standard in which the first two parameters are defined. * * @exception {DeveloperError} timeStandard is not a known TimeStandard. * @@ -319,7 +319,7 @@ define([ * @memberof JulianDate * * @param {Date} date The JavaScript Date object representing the time to be converted to a JulianDate. - * @param {TimeStandard} [timeStandard = TimeStandard.UTC] Indicates the time standard in which this JulianDate is represented. + * @param {TimeStandard} [timeStandard=TimeStandard.UTC] Indicates the time standard in which this JulianDate is represented. * * @returns {JulianDate} The new {@Link JulianDate} instance. * @@ -621,7 +621,7 @@ define([ * @memberof JulianDate * * @param {Number} totalDays The combined Julian Day Number and fractional day. - * @param {TimeStandard} [timeStandard = TimeStandard.UTC] Indicates the time standard in which the first parameter is defined. + * @param {TimeStandard} [timeStandard=TimeStandard.UTC] Indicates the time standard in which the first parameter is defined. * * @returns {JulianDate} The new {@Link JulianDate} instance. * diff --git a/Source/Core/KeyboardEventModifier.js b/Source/Core/KeyboardEventModifier.js index 8e91336fed77..b89a558ef0cb 100644 --- a/Source/Core/KeyboardEventModifier.js +++ b/Source/Core/KeyboardEventModifier.js @@ -14,7 +14,6 @@ define(function() { * * @type {Number} * @constant - * @default 0 */ SHIFT : 0, @@ -23,7 +22,6 @@ define(function() { * * @type {Number} * @constant - * @default 1 */ CTRL : 1, @@ -32,7 +30,6 @@ define(function() { * * @type {Number} * @constant - * @default 2 */ ALT : 2 }; diff --git a/Source/Core/Matrix4.js b/Source/Core/Matrix4.js index 88a876dd2466..bddebe030aac 100644 --- a/Source/Core/Matrix4.js +++ b/Source/Core/Matrix4.js @@ -85,7 +85,7 @@ define([ /** * The number of elements used to pack the object into an array. - * @Type {Number} + * @type {Number} */ Matrix4.packedLength = 16; @@ -912,8 +912,8 @@ define([ * @memberof Matrix4 * * @param {Object}[viewport = { x : 0.0, y : 0.0, width : 0.0, height : 0.0 }] The viewport's corners as shown in Example 1. - * @param {Number}[nearDepthRange = 0.0] The near plane distance in window coordinates. - * @param {Number}[farDepthRange = 1.0] The far plane distance in window coordinates. + * @param {Number}[nearDepthRange=0.0] The near plane distance in window coordinates. + * @param {Number}[farDepthRange=1.0] The far plane distance in window coordinates. * @param {Matrix4} [result] The object in which the result will be stored, if undefined a new instance will be created. * @returns The modified result parameter, or a new Matrix4 instance if one was not provided. * diff --git a/Source/Core/NearFarScalar.js b/Source/Core/NearFarScalar.js index 62af3ee43f4b..1eabb9c4c45a 100644 --- a/Source/Core/NearFarScalar.js +++ b/Source/Core/NearFarScalar.js @@ -75,7 +75,7 @@ define([ /** * The number of elements used to pack the object into an array. - * @Type {Number} + * @type {Number} */ NearFarScalar.packedLength = 4; diff --git a/Source/Core/Packable.js b/Source/Core/Packable.js index 70c6aedcbfa9..4fb618860fa4 100644 --- a/Source/Core/Packable.js +++ b/Source/Core/Packable.js @@ -17,7 +17,7 @@ define([ var Packable = { /** * The number of elements used to pack the object into an array. - * @Type {Number} + * @type {Number} */ packedLength : undefined, diff --git a/Source/Core/PackableForInterpolation.js b/Source/Core/PackableForInterpolation.js index 9bd1840fa5bd..cdac479557b9 100644 --- a/Source/Core/PackableForInterpolation.js +++ b/Source/Core/PackableForInterpolation.js @@ -17,7 +17,7 @@ define([ var PackableForInterpolation = { /** * The number of elements used to store the object into an array in its interpolatable form. - * @Type {Number} + * @type {Number} */ packedInterpolationLength : undefined, diff --git a/Source/Core/PolylinePipeline.js b/Source/Core/PolylinePipeline.js index 0a252a35b064..3c24f85e9595 100644 --- a/Source/Core/PolylinePipeline.js +++ b/Source/Core/PolylinePipeline.js @@ -178,7 +178,7 @@ define([ * * @memberof PolylinePipeline * - * @param {Cartesian3[]} positions The array of {Cartesian3} positions. + * @param {Cartesian3[]} positions The array of positions. * * @returns {Cartesian3[]} A new array of positions with no adjacent duplicate positions. Positions are shallow copied. * @@ -224,7 +224,7 @@ define([ * * @param {Cartesian3[]} positions The array of positions of type {Cartesian3}. * @param {Number} [granularity = CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. - * @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the positions lie. + * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the positions lie. * * @returns {Number[]} A new array of positions of type {Number} that have been subdivided and raised to the surface of the ellipsoid. * @@ -271,7 +271,7 @@ define([ * * @param {Number[]} positions The array of type {Number} representing positions. * @param {Number|Number[]} height A number or array of numbers representing the heights of each position. - * @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the positions lie. + * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the positions lie. * @param {Number[]} [result] An array to place the resultant positions in. * * @returns {Number[]} The array of positions scaled to height. diff --git a/Source/Core/PolylineVolumeGeometry.js b/Source/Core/PolylineVolumeGeometry.js index 1a9732fda5d9..cdf34399d919 100644 --- a/Source/Core/PolylineVolumeGeometry.js +++ b/Source/Core/PolylineVolumeGeometry.js @@ -184,7 +184,7 @@ define([ * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. * @param {Number} [options.height=0] The distance between the ellipsoid surface and the positions. * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. - * @param {Boolean} [options.cornerType = CornerType.ROUNDED] Determines the style of the corners. + * @param {Boolean} [options.cornerType=CornerType.ROUNDED] Determines the style of the corners. * * @see PolylineVolumeGeometry#createGeometry * diff --git a/Source/Core/PolylineVolumeOutlineGeometry.js b/Source/Core/PolylineVolumeOutlineGeometry.js index 78301ee251e5..4eca1238548c 100644 --- a/Source/Core/PolylineVolumeOutlineGeometry.js +++ b/Source/Core/PolylineVolumeOutlineGeometry.js @@ -95,11 +95,11 @@ define([ * @alias PolylineVolumeOutlineGeometry * @constructor * - * @param {Cartesian3[]} options.polylinePositions An array of {Cartesain3} positions that define the center of the polyline volume. - * @param {Number} options.shapePositions An array of {Cartesian2} positions that define the shape to be extruded along the polyline + * @param {Cartesian3[]} options.polylinePositions An array of positions that define the center of the polyline volume. + * @param {Number} options.shapePositions An array of positions that define the shape to be extruded along the polyline * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference. * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. - * @param {Boolean} [options.cornerType = CornerType.ROUNDED] Determines the style of the corners. + * @param {Boolean} [options.cornerType=CornerType.ROUNDED] Determines the style of the corners. * * @see PolylineVolumeOutlineGeometry#createGeometry * diff --git a/Source/Core/Quaternion.js b/Source/Core/Quaternion.js index 5dd5b35c9165..37e39104164e 100644 --- a/Source/Core/Quaternion.js +++ b/Source/Core/Quaternion.js @@ -185,7 +185,7 @@ define([ /** * The number of elements used to pack the object into an array. - * @Type {Number} + * @type {Number} */ Quaternion.packedLength = 4; @@ -245,7 +245,7 @@ define([ /** * The number of elements used to store the object into an array in its interpolatable form. - * @Type {Number} + * @type {Number} */ Quaternion.packedInterpolationLength = 3; diff --git a/Source/Core/Rectangle.js b/Source/Core/Rectangle.js index 0a2bf3ebe201..53a044728b91 100644 --- a/Source/Core/Rectangle.js +++ b/Source/Core/Rectangle.js @@ -139,7 +139,7 @@ define([ /** * The number of elements used to pack the object into an array. - * @Type {Number} + * @type {Number} */ Rectangle.packedLength = 4; diff --git a/Source/Core/ReferenceFrame.js b/Source/Core/ReferenceFrame.js index 5f0e051e9f74..d3a18379b2f4 100644 --- a/Source/Core/ReferenceFrame.js +++ b/Source/Core/ReferenceFrame.js @@ -13,15 +13,14 @@ define(function() { * * @type {Number} * @constant - * @default 0 */ FIXED : 0, + /** * The inertial frame. * * @type {Number} * @constant - * @default 1 */ INERTIAL : 1 }; diff --git a/Source/Core/ScreenSpaceEventType.js b/Source/Core/ScreenSpaceEventType.js index 985405b038f9..77d7860b109c 100644 --- a/Source/Core/ScreenSpaceEventType.js +++ b/Source/Core/ScreenSpaceEventType.js @@ -13,7 +13,6 @@ define(function() { * * @type {Number} * @constant - * @default 0 */ LEFT_DOWN : 0, @@ -22,7 +21,6 @@ define(function() { * * @type {Number} * @constant - * @default 1 */ LEFT_UP : 1, @@ -31,7 +29,6 @@ define(function() { * * @type {Number} * @constant - * @default 2 */ LEFT_CLICK : 2, @@ -40,7 +37,6 @@ define(function() { * * @type {Number} * @constant - * @default 3 */ LEFT_DOUBLE_CLICK : 3, @@ -49,7 +45,6 @@ define(function() { * * @type {Number} * @constant - * @default 5 */ RIGHT_DOWN : 5, @@ -58,7 +53,6 @@ define(function() { * * @type {Number} * @constant - * @default 6 */ RIGHT_UP : 6, @@ -67,7 +61,6 @@ define(function() { * * @type {Number} * @constant - * @default 7 */ RIGHT_CLICK : 7, @@ -76,7 +69,6 @@ define(function() { * * @type {Number} * @constant - * @default 8 */ RIGHT_DOUBLE_CLICK : 8, @@ -85,7 +77,6 @@ define(function() { * * @type {Number} * @constant - * @default 10 */ MIDDLE_DOWN : 10, @@ -94,7 +85,6 @@ define(function() { * * @type {Number} * @constant - * @default 11 */ MIDDLE_UP : 11, @@ -103,7 +93,6 @@ define(function() { * * @type {Number} * @constant - * @default 12 */ MIDDLE_CLICK : 12, @@ -112,7 +101,6 @@ define(function() { * * @type {Number} * @constant - * @default 13 */ MIDDLE_DOUBLE_CLICK : 13, @@ -121,7 +109,6 @@ define(function() { * * @type {Number} * @constant - * @default 15 */ MOUSE_MOVE : 15, @@ -130,7 +117,6 @@ define(function() { * * @type {Number} * @constant - * @default 16 */ WHEEL : 16, @@ -139,7 +125,6 @@ define(function() { * * @type {Number} * @constant - * @default 17 */ PINCH_START : 17, @@ -148,7 +133,6 @@ define(function() { * * @type {Number} * @constant - * @default 18 */ PINCH_END : 18, @@ -157,7 +141,6 @@ define(function() { * * @type {Number} * @constant - * @default 19 */ PINCH_MOVE : 19 }; diff --git a/Source/Core/TimeConstants.js b/Source/Core/TimeConstants.js index 9e7f99986106..0f764d41d6ae 100644 --- a/Source/Core/TimeConstants.js +++ b/Source/Core/TimeConstants.js @@ -79,7 +79,6 @@ define(function() { * on November 17, 1858. * @type {Number} * @constant - * @default */ MODIFIED_JULIAN_DATE_DIFFERENCE : 2400000.5 }; diff --git a/Source/Core/Visibility.js b/Source/Core/Visibility.js index b7b3ce846951..b1d2df01893d 100644 --- a/Source/Core/Visibility.js +++ b/Source/Core/Visibility.js @@ -16,23 +16,22 @@ define(function() { * * @type {Number} * @constant - * @default -1 */ NONE : -1, + /** * Represents that part, but not all, of an object is visible * * @type {Number} * @constant - * @default 0 */ PARTIAL : 0, + /** * Represents that an object is visible in its entirety. * * @type {Number} * @constant - * @default 1 */ FULL : 1 }; diff --git a/Source/DynamicScene/ConstantPositionProperty.js b/Source/DynamicScene/ConstantPositionProperty.js index 3685e167d139..c69d3398fb0a 100644 --- a/Source/DynamicScene/ConstantPositionProperty.js +++ b/Source/DynamicScene/ConstantPositionProperty.js @@ -62,7 +62,7 @@ define([ /** * Gets the reference frame in which the position is defined. * @memberof ConstantPositionProperty.prototype - * @Type {ReferenceFrame} + * @type {ReferenceFrame} * @default ReferenceFrame.FIXED; */ referenceFrame : { diff --git a/Source/DynamicScene/PositionProperty.js b/Source/DynamicScene/PositionProperty.js index 69333490d037..cfc8d5d59829 100644 --- a/Source/DynamicScene/PositionProperty.js +++ b/Source/DynamicScene/PositionProperty.js @@ -57,7 +57,7 @@ define([ /** * Gets the reference frame that the position is defined in. * @memberof PositionProperty.prototype - * @Type {ReferenceFrame} + * @type {ReferenceFrame} */ referenceFrame : { get : DeveloperError.throwInstantiationError diff --git a/Source/DynamicScene/PositionPropertyArray.js b/Source/DynamicScene/PositionPropertyArray.js index 6970f7c17804..8ec0d56e7184 100644 --- a/Source/DynamicScene/PositionPropertyArray.js +++ b/Source/DynamicScene/PositionPropertyArray.js @@ -74,7 +74,7 @@ define([ /** * Gets the reference frame in which the position is defined. * @memberof PositionPropertyArray.prototype - * @Type {ReferenceFrame} + * @type {ReferenceFrame} * @default ReferenceFrame.FIXED; */ referenceFrame : { diff --git a/Source/DynamicScene/SampledPositionProperty.js b/Source/DynamicScene/SampledPositionProperty.js index 4e34616c87d6..d9579cf41d93 100644 --- a/Source/DynamicScene/SampledPositionProperty.js +++ b/Source/DynamicScene/SampledPositionProperty.js @@ -68,7 +68,7 @@ define([ /** * Gets the reference frame in which the position is defined. * @memberof SampledPositionProperty.prototype - * @Type {ReferenceFrame} + * @type {ReferenceFrame} * @default ReferenceFrame.FIXED; */ referenceFrame : { diff --git a/Source/DynamicScene/TimeIntervalCollectionPositionProperty.js b/Source/DynamicScene/TimeIntervalCollectionPositionProperty.js index 66cd5e2d9887..927fcb1ed6e8 100644 --- a/Source/DynamicScene/TimeIntervalCollectionPositionProperty.js +++ b/Source/DynamicScene/TimeIntervalCollectionPositionProperty.js @@ -73,7 +73,7 @@ define([ /** * Gets the reference frame in which the position is defined. * @memberof TimeIntervalCollectionPositionProperty.prototype - * @Type {ReferenceFrame} + * @type {ReferenceFrame} * @default ReferenceFrame.FIXED; */ referenceFrame : { diff --git a/Source/Renderer/Context.js b/Source/Renderer/Context.js index 27b890d9cda8..4eb49ef10c78 100644 --- a/Source/Renderer/Context.js +++ b/Source/Renderer/Context.js @@ -1173,7 +1173,7 @@ define([ }; /** - * options.source can be {ImageData}, {Image}, {Canvas}, or {Video}. + * options.source can be {@link ImageData}, {@link Image}, {@link Canvas}, or {@link Video}. * * @exception {RuntimeError} When options.pixelFormat is DEPTH_COMPONENT or DEPTH_STENCIL, this WebGL implementation must support WEBGL_depth_texture. * @exception {RuntimeError} When options.pixelDatatype is FLOAT, this WebGL implementation must support the OES_texture_float extension. @@ -1279,7 +1279,7 @@ define([ }; /** - * options.source can be {ImageData}, {Image}, {Canvas}, or {Video}. + * options.source can be {@link ImageData}, {@link Image}, {@link Canvas}, or {@link Video}. * * @memberof Context * diff --git a/Source/Renderer/Texture.js b/Source/Renderer/Texture.js index 61b1ae28d49f..cee1f5e166a6 100644 --- a/Source/Renderer/Texture.js +++ b/Source/Renderer/Texture.js @@ -268,12 +268,12 @@ define([ }); /** - * Copy new image data into this texture, from a source {ImageData}, {Image}, {Canvas}, {Video}, + * Copy new image data into this texture, from a source {@link ImageData}, {@link Image}, {@link Canvas}, or {@link Video}. * or an object with width, height, and arrayBufferView properties. * * @memberof Texture * - * @param {Object} source The source {ImageData}, {Image}, {Canvas}, {Video}, + * @param {Object} source The source {@link ImageData}, {@link Image}, {@link Canvas}, or {@link Video}, * or an object with width, height, and arrayBufferView properties. * @param {Number} [xOffset=0] The offset in the x direction within the texture to copy into. * @param {Number} [yOffset=0] The offset in the y direction within the texture to copy into. diff --git a/Source/Scene/Camera.js b/Source/Scene/Camera.js index 33ee93e6cde2..5bacb7233783 100644 --- a/Source/Scene/Camera.js +++ b/Source/Scene/Camera.js @@ -49,7 +49,7 @@ define([ * The orientation forms an orthonormal basis with a view, up and right = view x up unit vectors. *

* The viewing frustum is defined by 6 planes. - * Each plane is represented by a {Cartesian4} object, where the x, y, and z components + * Each plane is represented by a {@link Cartesian4} object, where the x, y, and z components * define the unit vector normal to the plane, and the w component is the distance of the * plane from the origin/camera position. * diff --git a/Source/Scene/CameraEventType.js b/Source/Scene/CameraEventType.js index 145efc46c02c..98c9fb249d0c 100644 --- a/Source/Scene/CameraEventType.js +++ b/Source/Scene/CameraEventType.js @@ -13,7 +13,6 @@ define(function() { * * @type {Number} * @constant - * @default 0 */ LEFT_DRAG : 0, @@ -22,7 +21,6 @@ define(function() { * * @type {Number} * @constant - * @default 1 */ RIGHT_DRAG : 1, @@ -31,7 +29,6 @@ define(function() { * * @type {Number} * @constant - * @default 2 */ MIDDLE_DRAG : 2, @@ -40,7 +37,6 @@ define(function() { * * @type {Number} * @constant - * @default 3 */ WHEEL : 3, @@ -49,7 +45,6 @@ define(function() { * * @type {Number} * @constant - * @default 4 */ PINCH : 4 }; diff --git a/Source/Scene/HorizontalOrigin.js b/Source/Scene/HorizontalOrigin.js index 77ea26b56bc9..3a2f466db1f1 100644 --- a/Source/Scene/HorizontalOrigin.js +++ b/Source/Scene/HorizontalOrigin.js @@ -17,23 +17,22 @@ define(function() { * * @type {Number} * @constant - * @default 0 */ CENTER : 0, + /** * The origin is on the left side of the object. * * @type {Number} * @constant - * @default 1 */ LEFT : 1, + /** * The origin is on the right side of the object. * * @type {Number} * @constant - * @default -1 */ RIGHT : -1 }; diff --git a/Source/Scene/LabelStyle.js b/Source/Scene/LabelStyle.js index d542181d06fd..bace4f6c4035 100644 --- a/Source/Scene/LabelStyle.js +++ b/Source/Scene/LabelStyle.js @@ -15,7 +15,6 @@ define(function() { * * @type {Number} * @constant - * @default 0 */ FILL : 0, @@ -24,7 +23,6 @@ define(function() { * * @type {Number} * @constant - * @default 1 */ OUTLINE : 1, @@ -33,7 +31,6 @@ define(function() { * * @type {Number} * @constant - * @default 2 */ FILL_AND_OUTLINE : 2 }; diff --git a/Source/Scene/ModelAnimationLoop.js b/Source/Scene/ModelAnimationLoop.js index 2b40ce38fed2..e86713c3cea3 100644 --- a/Source/Scene/ModelAnimationLoop.js +++ b/Source/Scene/ModelAnimationLoop.js @@ -15,7 +15,6 @@ define(function() { * * @type {Number} * @constant - * @default 0 */ NONE : 0, @@ -24,7 +23,6 @@ define(function() { * * @type {Number} * @constant - * @default 1 */ REPEAT : 1, @@ -33,7 +31,6 @@ define(function() { * * @type {Number} * @constant - * @default 2 */ MIRRORED_REPEAT : 2 }; diff --git a/Source/Scene/OrthographicFrustum.js b/Source/Scene/OrthographicFrustum.js index fcaff9cfca85..c040607097ea 100644 --- a/Source/Scene/OrthographicFrustum.js +++ b/Source/Scene/OrthographicFrustum.js @@ -21,7 +21,7 @@ define([ /** * The viewing frustum is defined by 6 planes. - * Each plane is represented by a {Cartesian4} object, where the x, y, and z components + * Each plane is represented by a {@link Cartesian4} object, where the x, y, and z components * define the unit vector normal to the plane, and the w component is the distance of the * plane from the origin/camera position. * diff --git a/Source/Scene/PerspectiveFrustum.js b/Source/Scene/PerspectiveFrustum.js index f27d4f455256..ed178fd6988f 100644 --- a/Source/Scene/PerspectiveFrustum.js +++ b/Source/Scene/PerspectiveFrustum.js @@ -13,7 +13,7 @@ define([ /** * The viewing frustum is defined by 6 planes. - * Each plane is represented by a {Cartesian4} object, where the x, y, and z components + * Each plane is represented by a {@link Cartesian4} object, where the x, y, and z components * define the unit vector normal to the plane, and the w component is the distance of the * plane from the origin/camera position. * diff --git a/Source/Scene/PerspectiveOffCenterFrustum.js b/Source/Scene/PerspectiveOffCenterFrustum.js index d1473bc61bde..82537d2f8eb3 100644 --- a/Source/Scene/PerspectiveOffCenterFrustum.js +++ b/Source/Scene/PerspectiveOffCenterFrustum.js @@ -23,7 +23,7 @@ define([ /** * The viewing frustum is defined by 6 planes. - * Each plane is represented by a {Cartesian4} object, where the x, y, and z components + * Each plane is represented by a {@link Cartesian4} object, where the x, y, and z components * define the unit vector normal to the plane, and the w component is the distance of the * plane from the origin/camera position. * diff --git a/Source/Scene/Scene.js b/Source/Scene/Scene.js index ba982b664713..d1faa189e68e 100644 --- a/Source/Scene/Scene.js +++ b/Source/Scene/Scene.js @@ -1516,7 +1516,7 @@ define([ /** * Asynchronously transitions the scene to 2D. - * @param {Number} [duration = 2000] The amount of time, in milliseconds, for transition animations to complete. + * @param {Number} [duration=2000] The amount of time, in milliseconds, for transition animations to complete. * @memberof Scene */ Scene.prototype.morphTo2D = function(duration) { @@ -1529,7 +1529,7 @@ define([ /** * Asynchronously transitions the scene to Columbus View. - * @param {Number} [duration = 2000] The amount of time, in milliseconds, for transition animations to complete. + * @param {Number} [duration=2000] The amount of time, in milliseconds, for transition animations to complete. * @memberof Scene */ Scene.prototype.morphToColumbusView = function(duration) { @@ -1542,7 +1542,7 @@ define([ /** * Asynchronously transitions the scene to 3D. - * @param {Number} [duration = 2000] The amount of time, in milliseconds, for transition animations to complete. + * @param {Number} [duration=2000] The amount of time, in milliseconds, for transition animations to complete. * @memberof Scene */ Scene.prototype.morphTo3D = function(duration) { diff --git a/Source/Scene/SceneMode.js b/Source/Scene/SceneMode.js index cea9a1d94342..c34e45f2fba7 100644 --- a/Source/Scene/SceneMode.js +++ b/Source/Scene/SceneMode.js @@ -15,7 +15,6 @@ define(function() { * * @type {Number} * @constant - * @default 0 */ SCENE2D : 0, @@ -25,7 +24,6 @@ define(function() { * * @type {Number} * @constant - * @default 1 */ COLUMBUS_VIEW : 1, @@ -34,7 +32,6 @@ define(function() { * * @type {Number} * @constant - * @default 2 */ SCENE3D : 2, @@ -43,17 +40,16 @@ define(function() { * * @type {Number} * @constant - * @default 3 */ MORPHING : 3 }; - /** - * Returns the morph time for the given scene mode - * @param {SceneMode} value The scene mode - * @returns {Number} The morph time - */ - SceneMode.getMorphTime = function(value) { + /** + * Returns the morph time for the given scene mode + * @param {SceneMode} value The scene mode + * @returns {Number} The morph time + */ + SceneMode.getMorphTime = function(value) { if (value === SceneMode.SCENE3D) { return 1.0; } else if (value === SceneMode.MORPHING) { diff --git a/Source/Scene/VerticalOrigin.js b/Source/Scene/VerticalOrigin.js index ad468b7cbf70..c7eb959c3999 100644 --- a/Source/Scene/VerticalOrigin.js +++ b/Source/Scene/VerticalOrigin.js @@ -17,23 +17,22 @@ define(function() { * * @type {Number} * @constant - * @default 0 */ CENTER : 0, + /** * The origin is at the bottom of the object. * * @type {Number} * @constant - * @default 1 */ BOTTOM : 1, + /** * The origin is at the top of the object. * * @type {Number} * @constant - * @default -1 */ TOP : -1 }; diff --git a/Source/Widgets/SelectionIndicator/SelectionIndicatorViewModel.js b/Source/Widgets/SelectionIndicator/SelectionIndicatorViewModel.js index 11a4277a902d..5a3259892ad1 100644 --- a/Source/Widgets/SelectionIndicator/SelectionIndicatorViewModel.js +++ b/Source/Widgets/SelectionIndicator/SelectionIndicatorViewModel.js @@ -189,8 +189,8 @@ define([ }, /** * Gets or sets the function for converting the world position of the object to the screen space position. - * Expects the {Cartesian3} parameter for the position and the optional {Cartesian2} parameter for the result. - * Should return a {Cartesian2}. + * Expects the {@link Cartesian3} parameter for the position and the optional {@link Cartesian2} parameter for the result. + * Should return a {@link Cartesian2}. * * Defaults to SceneTransforms.wgs84ToWindowCoordinates *