diff --git a/Source/Core/AxisAlignedBoundingBox.js b/Source/Core/AxisAlignedBoundingBox.js index 490669ffcf0e..7f57fe9880ed 100644 --- a/Source/Core/AxisAlignedBoundingBox.js +++ b/Source/Core/AxisAlignedBoundingBox.js @@ -59,7 +59,7 @@ define([ * finding the points spaced the farthest apart on the x, y, and z axes. * @memberof AxisAlignedBoundingBox * - * @param {Array} positions List of points that the bounding box will enclose. Each point must have a x, y, and z properties. + * @param {Cartesian3[]} positions List of points that the bounding box will enclose. Each point must have a x, y, and z properties. * @param {AxisAlignedBoundingBox} [result] The object onto which to store the result. * @returns {AxisAlignedBoundingBox} The modified result parameter or a new AxisAlignedBoundingBox instance if one was not provided. * diff --git a/Source/Core/BoundingRectangle.js b/Source/Core/BoundingRectangle.js index 11546606db55..fcc0074b6f8d 100644 --- a/Source/Core/BoundingRectangle.js +++ b/Source/Core/BoundingRectangle.js @@ -66,7 +66,7 @@ define([ * The rectangle is oriented with the corner at the bottom left. * @memberof BoundingRectangle * - * @param {Array} positions List of points that the bounding rectangle will enclose. Each point must have x and y properties. + * @param {Cartesian2[]} positions List of points that the bounding rectangle will enclose. Each point must have x and y properties. * @param {BoundingRectangle} [result] The object onto which to store the result. * @returns {BoundingRectangle} The modified result parameter or a new BoundingRectangle instance if one was not provided. */ diff --git a/Source/Core/BoundingSphere.js b/Source/Core/BoundingSphere.js index fc9f8f815bb1..0738749570a8 100644 --- a/Source/Core/BoundingSphere.js +++ b/Source/Core/BoundingSphere.js @@ -72,7 +72,7 @@ define([ * Ritter's algorithm. The smaller of the two spheres is used to ensure a tight fit. * @memberof BoundingSphere * - * @param {Array} positions An array of points that the bounding sphere will enclose. Each point must have x, y, and z properties. + * @param {Cartesian3[]} positions An array of points that the bounding sphere will enclose. Each point must have x, y, and z properties. * @param {BoundingSphere} [result] The object onto which to store the result. * @returns {BoundingSphere} The modified result parameter or a new BoundingSphere instance if one was not provided. * @@ -312,7 +312,7 @@ define([ * * @memberof BoundingSphere * - * @param {Array} positions An array of points that the bounding sphere will enclose. Each point + * @param {Cartesian3[]} positions An array of points that the bounding sphere will enclose. Each point * is formed from three elements in the array in the order X, Y, Z. * @param {Cartesian3} [center=Cartesian3.ZERO] The position to which the positions are relative, which need not be the * origin of the coordinate system. This is useful when the positions are to be used for @@ -586,7 +586,7 @@ define([ * @memberof BoundingSphere * * @param {BoundingSphere} value The value to pack. - * @param {Array} array The array to pack into. + * @param {Number[]} array The array to pack into. * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. */ BoundingSphere.pack = function(value, array, startingIndex) { @@ -613,7 +613,7 @@ define([ * Retrieves an instance from a packed array. * @memberof BoundingSphere * - * @param {Array} array The packed array. + * @param {Number[]} array The packed array. * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. * @param {Cartesian3} [result] The object into which to store the result. */ diff --git a/Source/Core/Cartesian2.js b/Source/Core/Cartesian2.js index 95b93b6ec9f9..7b8438e137db 100644 --- a/Source/Core/Cartesian2.js +++ b/Source/Core/Cartesian2.js @@ -114,7 +114,7 @@ define([ * @memberof Cartesian2 * * @param {Cartesian2} value The value to pack. - * @param {Array} array The array to pack into. + * @param {Number[]} array The array to pack into. * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. */ Cartesian2.pack = function(value, array, startingIndex) { @@ -138,7 +138,7 @@ define([ * Retrieves an instance from a packed array. * @memberof Cartesian2 * - * @param {Array} array The packed array. + * @param {Number[]} array The packed array. * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. * @param {Cartesian2} [result] The object into which to store the result. */ @@ -163,7 +163,7 @@ define([ * Creates a Cartesian2 from two consecutive elements in an array. * @memberof Cartesian2 * - * @param {Array} array The array whose two consecutive elements correspond to the x and y components, respectively. + * @param {Number[]} array The array whose two consecutive elements correspond to the x and y components, respectively. * @param {Number} [startingIndex=0] The offset into the array of the first element, which corresponds to the x component. * @param {Cartesian2} [result] The object onto which to store the result. * diff --git a/Source/Core/Cartesian3.js b/Source/Core/Cartesian3.js index 15f7a63f4db0..058a8e722c06 100644 --- a/Source/Core/Cartesian3.js +++ b/Source/Core/Cartesian3.js @@ -143,7 +143,7 @@ define([ * @memberof Cartesian3 * * @param {Cartesian3} value The value to pack. - * @param {Array} array The array to pack into. + * @param {Number[]} array The array to pack into. * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. */ Cartesian3.pack = function(value, array, startingIndex) { @@ -168,7 +168,7 @@ define([ * Retrieves an instance from a packed array. * @memberof Cartesian3 * - * @param {Array} array The packed array. + * @param {Number[]} array The packed array. * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. * @param {Cartesian3} [result] The object into which to store the result. */ @@ -194,7 +194,7 @@ define([ * Creates a Cartesian3 from three consecutive elements in an array. * @memberof Cartesian3 * - * @param {Array} array The array whose three consecutive elements correspond to the x, y, and z components, respectively. + * @param {Number[]} array The array whose three consecutive elements correspond to the x, y, and z components, respectively. * @param {Number} [startingIndex=0] The offset into the array of the first element, which corresponds to the x component. * @param {Cartesian3} [result] The object onto which to store the result. * @@ -846,9 +846,9 @@ define([ * Returns an array of Cartesian3 positions given an array of longitude and latitude values given in degrees. * @memberof Cartesian3 * - * @param {Array} coordinates A list of longitude and latitude values. Values alternate [longitude, latitude, longitude, latitude...]. + * @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 {Array} [result] An array of Cartesian3 objects to store the result. + * @param {Cartesian3[]} [result] An array of Cartesian3 objects to store the result. * * @returns {Cartesian3[]} The array of positions. * @@ -874,9 +874,9 @@ define([ * Returns an array of Cartesian3 positions given an array of longitude and latitude values given in radians. * @memberof Cartesian3 * - * @param {Array} coordinates A list of longitude and latitude values. Values alternate [longitude, latitude, longitude, latitude...]. + * @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 {Array} [result] An array of Cartesian3 objects to store the result. + * @param {Cartesian3[]} [result] An array of Cartesian3 objects to store the result. * * @returns {Cartesian3[]} The array of positions. * @@ -916,9 +916,9 @@ define([ * Returns an array of Cartesian3 positions given an array of longitude, latitude and height values where longitude and latitude are given in degrees. * @memberof Cartesian3 * - * @param {Array} coordinates A list of longitude, latitude and height values. Values alternate [longitude, latitude, height,, longitude, latitude, height...]. + * @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 {Array} [result] An array of Cartesian3 objects to store the result. + * @param {Cartesian3[]} [result] An array of Cartesian3 objects to store the result. * * @returns {Cartesian3[]} The array of positions. * @@ -952,9 +952,9 @@ define([ * Returns an array of Cartesian3 positions given an array of longitude, latitude and height values where longitude and latitude are given in radians. * @memberof Cartesian3 * - * @param {Array} coordinates A list of longitude, latitude and height values. Values alternate [longitude, latitude, height,, longitude, latitude, height...]. + * @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 {Array} [result] An array of Cartesian3 objects to store the result. + * @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 e35d2c675460..32b7096b25a7 100644 --- a/Source/Core/Cartesian4.js +++ b/Source/Core/Cartesian4.js @@ -141,7 +141,7 @@ define([ * @memberof Cartesian4 * * @param {Cartesian4} value The value to pack. - * @param {Array} array The array to pack into. + * @param {Number[]} array The array to pack into. * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. */ Cartesian4.pack = function(value, array, startingIndex) { @@ -167,7 +167,7 @@ define([ * Retrieves an instance from a packed array. * @memberof Cartesian4 * - * @param {Array} array The packed array. + * @param {Number[]} array The packed array. * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. * @param {Cartesian4} [result] The object into which to store the result. */ @@ -196,7 +196,7 @@ define([ * Creates a Cartesian4 from four consecutive elements in an array. * @memberof Cartesian4 * - * @param {Array} array The array whose four consecutive elements correspond to the x, y, z, and w components, respectively. + * @param {Number[]} array The array whose four consecutive elements correspond to the x, y, z, and w components, respectively. * @param {Number} [startingIndex=0] The offset into the array of the first element, which corresponds to the x component. * @param {Cartesian4} [result] The object onto which to store the result. * diff --git a/Source/Core/CatmullRomSpline.js b/Source/Core/CatmullRomSpline.js index 78bf29b2ce67..e2eae16701e5 100644 --- a/Source/Core/CatmullRomSpline.js +++ b/Source/Core/CatmullRomSpline.js @@ -104,9 +104,9 @@ define([ * @alias CatmullRomSpline * @constructor * - * @param {Array} options.times An array of strictly increasing, unit-less, floating-point times at each point. + * @param {Number[]} options.times An array of strictly increasing, unit-less, floating-point times at each point. * The values are in no way connected to the clock time. They are the parameterization for the curve. - * @param {Array} options.points The array of {@link Cartesian3} control points. + * @param {Cartesian3[]} options.points The array of {@link Cartesian3} control points. * @param {Cartesian3} [options.firstTangent] The tangent of the curve at the first control point. * If the tangent is not given, it will be estimated. * @param {Cartesian3} [options.lastTangent] The tangent of the curve at the last control point. @@ -191,7 +191,7 @@ define([ * * @memberof CatmullRomSpline.prototype * - * @type {Array} + * @type {Number[]} * @readonly */ times : { @@ -205,7 +205,7 @@ define([ * * @memberof CatmullRomSpline.prototype * - * @type {Array} + * @type {Cartesian3[]} * @readonly */ points : { diff --git a/Source/Core/Color.js b/Source/Core/Color.js index 23f1105b4501..a9aed8afede3 100644 --- a/Source/Core/Color.js +++ b/Source/Core/Color.js @@ -382,7 +382,7 @@ define([ * @memberof Color * * @param {Color} value The value to pack. - * @param {Array} array The array to pack into. + * @param {Number[]} array The array to pack into. * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. */ Color.pack = function(value, array, startingIndex) { @@ -406,7 +406,7 @@ define([ * Retrieves an instance from a packed array. * @memberof Color * - * @param {Array} array The packed array. + * @param {Number[]} array The packed array. * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. * @param {Color} [result] The object into which to store the result. */ @@ -563,8 +563,8 @@ define([ * that are in the range of 0 to 255. * @memberof Color * - * @param {Array} [result] The array to store the result in, if undefined a new instance will be created. - * @returns {Array} The modified result parameter or a new instance if result was undefined. + * @param {Number[]} [result] The array to store the result in, if undefined a new instance will be created. + * @returns {Number[]} The modified result parameter or a new instance if result was undefined. */ Color.prototype.toBytes = function(result) { var red = Color.floatToByte(this.red); diff --git a/Source/Core/CorridorGeometry.js b/Source/Core/CorridorGeometry.js index d15a670feaf6..8beecd57771c 100644 --- a/Source/Core/CorridorGeometry.js +++ b/Source/Core/CorridorGeometry.js @@ -626,7 +626,7 @@ define([ * @alias CorridorGeometry * @constructor * - * @param {Array} options.positions An array of {Cartesain3} positions that define the center of the corridor. + * @param {Cartesian3[]} options.positions An array of {Cartesain3} 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. diff --git a/Source/Core/CorridorOutlineGeometry.js b/Source/Core/CorridorOutlineGeometry.js index 4aca880d5021..d36ac9271a37 100644 --- a/Source/Core/CorridorOutlineGeometry.js +++ b/Source/Core/CorridorOutlineGeometry.js @@ -306,7 +306,7 @@ define([ * @alias CorridorOutlineGeometry * @constructor * - * @param {Array} options.positions An array of {Cartesain3} positions that define the center of the corridor outline. + * @param {Cartesian3[]} options.positions An array of {Cartesain3} 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. diff --git a/Source/Core/CubicRealPolynomial.js b/Source/Core/CubicRealPolynomial.js index dff9b0f7619b..cf2d465d2a77 100644 --- a/Source/Core/CubicRealPolynomial.js +++ b/Source/Core/CubicRealPolynomial.js @@ -162,7 +162,7 @@ define([ * @param {Number} b The coefficient of the 2nd order monomial. * @param {Number} c The coefficient of the 1st order monomial. * @param {Number} d The coefficient of the 0th order monomial. - * @returns {Array} The real valued roots. + * @returns {Number[]} The real valued roots. */ CubicRealPolynomial.realRoots = function(a, b, c, d) { //>>includeStart('debug', pragmas.debug); diff --git a/Source/Core/Ellipsoid.js b/Source/Core/Ellipsoid.js index 5a29b4d31e35..5dc35b4ae73d 100644 --- a/Source/Core/Ellipsoid.js +++ b/Source/Core/Ellipsoid.js @@ -319,9 +319,9 @@ define([ * Converts the provided array of cartographics to an array of Cartesians. * @memberof Ellipsoid * - * @param {Array} cartographics An array of cartographic positions. - * @param {Array} [result] The object onto which to store the result. - * @returns {Array} The modified result parameter or a new Array instance if none was provided. + * @param {Cartographic[]} cartographics An array of cartographic positions. + * @param {Cartesian3[]} [result] The object onto which to store the result. + * @returns {Cartesian3[]} The modified result parameter or a new Array instance if none was provided. * * @example * //Convert an array of Cartographics and determine their Cartesian representation on a WGS84 ellipsoid. @@ -395,15 +395,15 @@ define([ * Converts the provided array of cartesians to an array of cartographics. * @memberof Ellipsoid * - * @param {Array} cartesians An array of Cartesian positions. - * @param {Array} [result] The object onto which to store the result. - * @returns {Array} The modified result parameter or a new Array instance if none was provided. + * @param {Cartesian3[]} cartesians An array of Cartesian positions. + * @param {Cartographic[]} [result] The object onto which to store the result. + * @returns {Cartographic[]} The modified result parameter or a new Array instance if none was provided. * * @example * //Create an array of Cartesians and determine their Cartographic representation on a WGS84 ellipsoid. - * var positions = [new Cesium.Cartesian(17832.12, 83234.52, 952313.73), - * new Cesium.Cartesian(17832.13, 83234.53, 952313.73), - * new Cesium.Cartesian(17832.14, 83234.54, 952313.73)] + * var positions = [new Cesium.Cartesian3(17832.12, 83234.52, 952313.73), + * new Cesium.Cartesian3(17832.13, 83234.53, 952313.73), + * new Cesium.Cartesian3(17832.14, 83234.54, 952313.73)] * var cartographicPositions = Cesium.Ellipsoid.WGS84.cartesianArrayToCartographicArray(positions); */ Ellipsoid.prototype.cartesianArrayToCartographicArray = function(cartesians, result) { diff --git a/Source/Core/EllipsoidTangentPlane.js b/Source/Core/EllipsoidTangentPlane.js index 63506bb8d617..44b5b82e6049 100644 --- a/Source/Core/EllipsoidTangentPlane.js +++ b/Source/Core/EllipsoidTangentPlane.js @@ -158,9 +158,9 @@ define([ * Computes the projection of the provided 3D positions onto the 2D plane. * @memberof EllipsoidTangentPlane * - * @param {Array} cartesians The array of points to project. - * @param {Array} [result] The array of Cartesian2 instances onto which to store results. - * @returns {Array} The modified result parameter or a new array of Cartesian2 instances if none was provided. + * @param {Cartesian3[]} cartesians The array of points to project. + * @param {Cartesian2[]} [result] The array of Cartesian2 instances onto which to store results. + * @returns {Cartesian2[]} The modified result parameter or a new array of Cartesian2 instances if none was provided. */ EllipsoidTangentPlane.prototype.projectPointsOntoPlane = function(cartesians, result) { //>>includeStart('debug', pragmas.debug); @@ -192,9 +192,9 @@ define([ * Computes the projection of the provided 2D positions onto the 3D ellipsoid. * @memberof EllipsoidTangentPlane * - * @param {Array} cartesians The array of points to project. - * @param {Array} [result] The array of Cartesian3 instances onto which to store results. - * @returns {Array} The modified result parameter or a new array of Cartesian3 instances if none was provided. + * @param {Cartesian2[]} cartesians The array of points to project. + * @param {Cartesian3[]} [result] The array of Cartesian3 instances onto which to store results. + * @returns {Cartesian3[]} The modified result parameter or a new array of Cartesian3 instances if none was provided. */ EllipsoidTangentPlane.prototype.projectPointsOntoEllipsoid = function(cartesians, result) { //>>includeStart('debug', pragmas.debug); diff --git a/Source/Core/EncodedCartesian3.js b/Source/Core/EncodedCartesian3.js index c5f80cd0899e..f5763022674f 100644 --- a/Source/Core/EncodedCartesian3.js +++ b/Source/Core/EncodedCartesian3.js @@ -153,7 +153,7 @@ define([ *

* * @param {Cartesian3} cartesian The cartesian to encode. - * @param {Array} cartesianArray The array to write to. + * @param {Number[]} cartesianArray The array to write to. * @param {Number} index The index into the array to start writing. Six elements will be written. * * @exception {DeveloperError} index must be a number greater than or equal to 0. diff --git a/Source/Core/Geometry.js b/Source/Core/Geometry.js index fae055579b85..5aacb82f6650 100644 --- a/Source/Core/Geometry.js +++ b/Source/Core/Geometry.js @@ -23,7 +23,7 @@ define([ * * @param {GeometryAttributes} options.attributes Attributes, which make up the geometry's vertices. * @param {PrimitiveType} options.primitiveType The type of primitives in the geometry. - * @param {Array} [options.indices] Optional index data that determines the primitives in the geometry. + * @param {Uint16Array|Uint32Array} [options.indices] Optional index data that determines the primitives in the geometry. * @param {BoundingSphere} [options.boundingSphere] An optional bounding sphere that fully enclosed the geometry. * diff --git a/Source/Core/GeometryAttribute.js b/Source/Core/GeometryAttribute.js index fa988fe8e816..2554081f7eb3 100644 --- a/Source/Core/GeometryAttribute.js +++ b/Source/Core/GeometryAttribute.js @@ -20,7 +20,7 @@ define([ * @param {ComponentDatatype} [options.componentDatatype] The datatype of each component in the attribute, e.g., individual elements in values. * @param {Number} [options.componentsPerAttribute] A number between 1 and 4 that defines the number of components in an attributes. * @param {Boolean} [options.normalize=false] When true and componentDatatype is an integer format, indicate that the components should be mapped to the range [0, 1] (unsigned) or [-1, 1] (signed) when they are accessed as floating-point for rendering. - * @param {Array} [options.values] The values for the attributes stored in a typed array. + * @param {Number[]} [options.values] The values for the attributes stored in a typed array. * * @exception {DeveloperError} options.componentsPerAttribute must be between 1 and 4. * diff --git a/Source/Core/GeometryInstanceAttribute.js b/Source/Core/GeometryInstanceAttribute.js index 0ec391fb0db8..287b13824cd2 100644 --- a/Source/Core/GeometryInstanceAttribute.js +++ b/Source/Core/GeometryInstanceAttribute.js @@ -18,7 +18,7 @@ define([ * @param {ComponentDatatype} [options.componentDatatype] The datatype of each component in the attribute, e.g., individual elements in values. * @param {Number} [options.componentsPerAttribute] A number between 1 and 4 that defines the number of components in an attributes. * @param {Boolean} [options.normalize=false] When true and componentDatatype is an integer format, indicate that the components should be mapped to the range [0, 1] (unsigned) or [-1, 1] (signed) when they are accessed as floating-point for rendering. - * @param {Array} [options.value] The value for the attribute. + * @param {Number[]} [options.value] The value for the attribute. * * @exception {DeveloperError} options.componentsPerAttribute must be between 1 and 4. * diff --git a/Source/Core/GeometryPipeline.js b/Source/Core/GeometryPipeline.js index 314ce12ea28b..427f6a60419f 100644 --- a/Source/Core/GeometryPipeline.js +++ b/Source/Core/GeometryPipeline.js @@ -480,7 +480,7 @@ define([ * * @param {Geometry} geometry The geometry to be split into multiple geometries. * - * @returns {Array} An array of geometries, each with indices that fit into unsigned shorts. + * @returns {Geometry[]} An array of geometries, each with indices that fit into unsigned shorts. * * @exception {DeveloperError} geometry.primitiveType must equal to PrimitiveType.TRIANGLES, PrimitiveType.LINES, or PrimitiveType.POINTS * @exception {DeveloperError} All geometry attribute lists must have the same number of attributes. @@ -885,7 +885,7 @@ define([ * This is used by {@link Primitive} to efficiently render a large amount of static data. *

* - * @param {Array} [instances] The array of {@link GeometryInstance} objects whose geometry will be combined. + * @param {GeometryInstance[]} [instances] The array of {@link GeometryInstance} objects whose geometry will be combined. * * @returns {Geometry} A single geometry created from the provided geometry instances. * diff --git a/Source/Core/HermitePolynomialApproximation.js b/Source/Core/HermitePolynomialApproximation.js index 29264380f681..2a5b1ddeb22b 100644 --- a/Source/Core/HermitePolynomialApproximation.js +++ b/Source/Core/HermitePolynomialApproximation.js @@ -82,16 +82,16 @@ define([ * * @param {Number} x The independent variable for which the dependent variables will be interpolated. * - * @param {Array} xTable The array of independent variables to use to interpolate. The values + * @param {Number[]} xTable The array of independent variables to use to interpolate. The values * in this array must be in increasing order and the same value must not occur twice in the array. * - * @param {Array} yTable The array of dependent variables to use to interpolate. For a set of three + * @param {Number[]} yTable The array of dependent variables to use to interpolate. For a set of three * dependent values (p,q,w) at time 1 and time 2 this should be as follows: {p1, q1, w1, p2, q2, w2}. * * @param {Number} yStride The number of dependent variable values in yTable corresponding to * each independent variable value in xTable. * - * @param {Array} [result] An existing array into which to store the result. + * @param {Number[]} [result] An existing array into which to store the result. * * @returns The array of interpolated values, or the result parameter if one was provided. * diff --git a/Source/Core/HermiteSpline.js b/Source/Core/HermiteSpline.js index d31efb63bb12..331207ed6a7c 100644 --- a/Source/Core/HermiteSpline.js +++ b/Source/Core/HermiteSpline.js @@ -134,11 +134,11 @@ define([ * @alias HermiteSpline * @constructor * - * @param {Array} options.times An array of strictly increasing, unit-less, floating-point times at each point. + * @param {Number[]} options.times An array of strictly increasing, unit-less, floating-point times at each point. * The values are in no way connected to the clock time. They are the parameterization for the curve. - * @param {Array} options.points The array of {@link Cartesian3} control points. - * @param {Array} options.inTangents The array of {@link Cartesian3} incoming tangents at each control point. - * @param {Array} options.outTangents The array of {@link Cartesian3} outgoing tangents at each control point. + * @param {Cartesian3[]} options.points The array of {@link Cartesian3} control points. + * @param {Cartesian3[]} options.inTangents The array of {@link Cartesian3} incoming tangents at each control point. + * @param {Cartesian3[]} options.outTangents The array of {@link Cartesian3} outgoing tangents at each control point. * * @exception {DeveloperError} points.length must be greater than or equal to 2. * @exception {DeveloperError} times.length must be equal to points.length. @@ -215,7 +215,7 @@ define([ * * @memberof HermiteSpline.prototype * - * @type {Array} + * @type {Number[]} * @readonly */ times : { @@ -229,7 +229,7 @@ define([ * * @memberof HermiteSpline.prototype * - * @type {Array} + * @type {Cartesian3[]} * @readonly */ points : { @@ -243,7 +243,7 @@ define([ * * @memberof HermiteSpline.prototype * - * @type {Array} + * @type {Cartesian3[]} * @readonly */ inTangents : { @@ -257,7 +257,7 @@ define([ * * @memberof HermiteSpline.prototype * - * @type {Array} + * @type {Cartesian3[]} * @readonly */ outTangents : { @@ -272,9 +272,9 @@ define([ * The curves are guaranteed to be at least in the class C1. * @memberof HermiteSpline * - * @param {Array} options.times The array of control point times. - * @param {Array} options.points The array of control points. - * @param {Array} options.tangents The array of tangents at the control points. + * @param {Number[]} options.times The array of control point times. + * @param {Cartesian3[]} options.points The array of control points. + * @param {Cartesian3[]} options.tangents The array of tangents at the control points. * @returns {HermiteSpline} A hermite spline. * * @exception {DeveloperError} points, times and tangents are required. @@ -339,8 +339,8 @@ define([ * to create a curve in the class C2. * @memberof HermiteSpline * - * @param {Array} options.times The array of control point times. - * @param {Array} options.points The array of control points. + * @param {Number[]} options.times The array of control point times. + * @param {Cartesian3[]} options.points The array of control points. * @returns {HermiteSpline|LinearSpline} A hermite spline or a linear spline if less than 3 control points were given. * * @exception {DeveloperError} points and times are required. @@ -402,8 +402,8 @@ define([ * to create a curve in the class C2. * @memberof HermiteSpline * - * @param {Array} options.times The array of control point times. - * @param {Array} options.points The array of control points. + * @param {Number[]} options.times The array of control point times. + * @param {Cartesian3[]} options.points The array of control points. * @param {Cartesian3} options.firstTangent The outgoing tangent of the first control point. * @param {Cartesian3} options.lastTangent The incoming tangent of the last control point. * @returns {HermiteSpline|LinearSpline} A hermite spline or a linear spline if less than 3 control points were given. diff --git a/Source/Core/IndexDatatype.js b/Source/Core/IndexDatatype.js index 74b28ba2368a..71355960e20c 100644 --- a/Source/Core/IndexDatatype.js +++ b/Source/Core/IndexDatatype.js @@ -97,7 +97,7 @@ define([ * @param {Number} numberOfVertices Number of vertices that the indices will reference. * @param {Any} indicesLengthOrArray Passed through to the typed array constructor. * - * @returns {Array} A Uint16Array or Uint32Array constructed with indicesLengthOrArray. + * @returns {Uint16Aray|Uint32Array} A Uint16Array or Uint32Array constructed with indicesLengthOrArray. * * @example * this.indices = Cesium.IndexDatatype.createTypedArray(positions.length / 3, numberOfIndices); diff --git a/Source/Core/InterpolationAlgorithm.js b/Source/Core/InterpolationAlgorithm.js index 30f714b66ab8..5c9ea131e9e2 100644 --- a/Source/Core/InterpolationAlgorithm.js +++ b/Source/Core/InterpolationAlgorithm.js @@ -37,16 +37,16 @@ define([ * * @param {Number} x The independent variable for which the dependent variables will be interpolated. * - * @param {Array} xTable The array of independent variables to use to interpolate. The values + * @param {Number[]} xTable The array of independent variables to use to interpolate. The values * in this array must be in increasing order and the same value must not occur twice in the array. * - * @param {Array} yTable The array of dependent variables to use to interpolate. For a set of three + * @param {Number[]} yTable The array of dependent variables to use to interpolate. For a set of three * dependent values (p,q,w) at time 1 and time 2 this should be as follows: {p1, q1, w1, p2, q2, w2}. * * @param {Number} yStride The number of dependent variable values in yTable corresponding to * each independent variable value in xTable. * - * @param {Array} [result] An existing array into which to store the result. + * @param {Number[]} [result] An existing array into which to store the result. * * @returns The array of interpolated values, or the result parameter if one was provided. */ diff --git a/Source/Core/LagrangePolynomialApproximation.js b/Source/Core/LagrangePolynomialApproximation.js index 23c7f529f154..8f1ce61e45a2 100644 --- a/Source/Core/LagrangePolynomialApproximation.js +++ b/Source/Core/LagrangePolynomialApproximation.js @@ -36,18 +36,18 @@ define([ * * @param {Number} x The independent variable for which the dependent variables will be interpolated. * - * @param {Array} xTable The array of independent variables to use to interpolate. The values + * @param {Number[]} xTable The array of independent variables to use to interpolate. The values * in this array must be in increasing order and the same value must not occur twice in the array. * - * @param {Array} yTable The array of dependent variables to use to interpolate. For a set of three + * @param {Number[]} yTable The array of dependent variables to use to interpolate. For a set of three * dependent values (p,q,w) at time 1 and time 2 this should be as follows: {p1, q1, w1, p2, q2, w2}. * * @param {Number} yStride The number of dependent variable values in yTable corresponding to * each independent variable value in xTable. * - * @param {Array} [result] An existing array into which to store the result. + * @param {Number[]} [result] An existing array into which to store the result. * - * @returns The array of interpolated values, or the result parameter if one was provided. + * @returns {Number[]} The array of interpolated values, or the result parameter if one was provided. * * @see LinearApproximation * @see HermitePolynomialApproximation diff --git a/Source/Core/LeapSecond.js b/Source/Core/LeapSecond.js index e0bc5e9d4d99..ff00081efaf9 100644 --- a/Source/Core/LeapSecond.js +++ b/Source/Core/LeapSecond.js @@ -66,7 +66,7 @@ define([ /** * The list of leap seconds used throughout Cesium. * @memberof LeapSecond - * @type {Array} + * @type {LeapSecond[]} */ leapSeconds: { get: function() { diff --git a/Source/Core/LinearApproximation.js b/Source/Core/LinearApproximation.js index fe4613f7f439..e0709a07b139 100644 --- a/Source/Core/LinearApproximation.js +++ b/Source/Core/LinearApproximation.js @@ -47,16 +47,16 @@ define([ * * @param {Number} x The independent variable for which the dependent variables will be interpolated. * - * @param {Array} xTable The array of independent variables to use to interpolate. The values + * @param {Number[]} xTable The array of independent variables to use to interpolate. The values * in this array must be in increasing order and the same value must not occur twice in the array. * - * @param {Array} yTable The array of dependent variables to use to interpolate. For a set of three + * @param {Number[]} yTable The array of dependent variables to use to interpolate. For a set of three * dependent values (p,q,w) at time 1 and time 2 this should be as follows: {p1, q1, w1, p2, q2, w2}. * * @param {Number} yStride The number of dependent variable values in yTable corresponding to * each independent variable value in xTable. * - * @param {Array} [result] An existing array into which to store the result. + * @param {Number[]} [result] An existing array into which to store the result. * * @returns The array of interpolated values, or the result parameter if one was provided. * diff --git a/Source/Core/LinearSpline.js b/Source/Core/LinearSpline.js index 5cba7128d8e5..1dca01d6a055 100644 --- a/Source/Core/LinearSpline.js +++ b/Source/Core/LinearSpline.js @@ -21,9 +21,9 @@ define([ * @alias LinearSpline * @constructor * - * @param {Array} options.times An array of strictly increasing, unit-less, floating-point times at each point. + * @param {Number[]} options.times An array of strictly increasing, unit-less, floating-point times at each point. * The values are in no way connected to the clock time. They are the parameterization for the curve. - * @param {Array} options.points The array of {@link Cartesian3} control points. + * @param {Cartesian3[]} options.points The array of {@link Cartesian3} control points. * * @exception {DeveloperError} points.length must be greater than or equal to 2. * @exception {DeveloperError} times.length must be equal to points.length. @@ -79,7 +79,7 @@ define([ * * @memberof LinearSpline.prototype * - * @type {Array} + * @type {Number[]} * @readonly */ times : { @@ -93,7 +93,7 @@ define([ * * @memberof LinearSpline.prototype * - * @type {Array} + * @type {Cartesian3[]} * @readonly */ points : { diff --git a/Source/Core/Matrix2.js b/Source/Core/Matrix2.js index 8d59dc1914e7..ea2ac3412c69 100644 --- a/Source/Core/Matrix2.js +++ b/Source/Core/Matrix2.js @@ -65,7 +65,7 @@ define([ * Creates a Matrix2 from 4 consecutive elements in an array. * @memberof Matrix2 * - * @param {Array} array The array whose 4 consecutive elements correspond to the positions of the matrix. Assumes column-major order. + * @param {Number[]} array The array whose 4 consecutive elements correspond to the positions of the matrix. Assumes column-major order. * @param {Number} [startingIndex=0] The offset into the array of the first element, which corresponds to first column first row position in the matrix. * @param {Matrix2} [result] The object onto which to store the result. * @@ -108,7 +108,7 @@ define([ * @memberof Matrix2 * @function * - * @param {Array} values The column-major order array. + * @param {Number[]} values The column-major order array. * @param {Matrix2} [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 Matrix2 instance if one was not provided. */ @@ -127,7 +127,7 @@ define([ * The resulting matrix will be in column-major order. * @memberof Matrix2 * - * @param {Array} values The row-major order array. + * @param {Number[]} values The row-major order array. * @param {Matrix2} [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 Matrix2 instance if one was not provided. */ @@ -259,8 +259,8 @@ define([ * @memberof Matrix2 * * @param {Matrix2} matrix The matrix to use.. - * @param {Array} [result] The Array onto which to store the result. - * @returns {Array} The modified Array parameter or a new Array instance if one was not provided. + * @param {Number[]} [result] The Array onto which to store the result. + * @returns {Number[]} The modified Array parameter or a new Array instance if one was not provided. */ Matrix2.toArray = function(matrix, result) { //>>includeStart('debug', pragmas.debug); diff --git a/Source/Core/Matrix3.js b/Source/Core/Matrix3.js index 434fd3618cc4..0b573c983dfe 100644 --- a/Source/Core/Matrix3.js +++ b/Source/Core/Matrix3.js @@ -86,7 +86,7 @@ define([ * Creates a Matrix3 from 9 consecutive elements in an array. * @memberof Matrix3 * - * @param {Array} array The array whose 9 consecutive elements correspond to the positions of the matrix. Assumes column-major order. + * @param {Number[]} array The array whose 9 consecutive elements correspond to the positions of the matrix. Assumes column-major order. * @param {Number} [startingIndex=0] The offset into the array of the first element, which corresponds to first column first row position in the matrix. * @param {Matrix3} [result] The object onto which to store the result. * @@ -136,7 +136,7 @@ define([ * @memberof Matrix3 * @function * - * @param {Array} values The column-major order array. + * @param {Number[]} values The column-major order array. * @param {Matrix3} [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 Matrix3 instance if one was not provided. */ @@ -155,7 +155,7 @@ define([ * The resulting matrix will be in column-major order. * @memberof Matrix3 * - * @param {Array} values The row-major order array. + * @param {Number[]} values The row-major order array. * @param {Matrix3} [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 Matrix3 instance if one was not provided. */ @@ -458,8 +458,8 @@ define([ * @memberof Matrix3 * * @param {Matrix3} matrix The matrix to use.. - * @param {Array} [result] The Array onto which to store the result. - * @returns {Array} The modified Array parameter or a new Array instance if one was not provided. + * @param {Number[]} [result] The Array onto which to store the result. + * @returns {Number[]} The modified Array parameter or a new Array instance if one was not provided. */ Matrix3.toArray = function(matrix, result) { //>>includeStart('debug', pragmas.debug); diff --git a/Source/Core/Matrix4.js b/Source/Core/Matrix4.js index c3b3fea64d52..3619e7ae89f8 100644 --- a/Source/Core/Matrix4.js +++ b/Source/Core/Matrix4.js @@ -94,7 +94,7 @@ define([ * @memberof Matrix4 * * @param {Matrix4} value The value to pack. - * @param {Array} array The array to pack into. + * @param {Number[]} array The array to pack into. * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. */ Matrix4.pack = function(value, array, startingIndex) { @@ -132,7 +132,7 @@ define([ * Retrieves an instance from a packed array. * @memberof Matrix4 * - * @param {Array} array The packed array. + * @param {Number[]} array The packed array. * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. * @param {Matrix4} [result] The object into which to store the result. */ @@ -209,7 +209,7 @@ define([ * Creates a Matrix4 from 16 consecutive elements in an array. * @memberof Matrix4 * - * @param {Array} array The array whose 16 consecutive elements correspond to the positions of the matrix. Assumes column-major order. + * @param {Number[]} array The array whose 16 consecutive elements correspond to the positions of the matrix. Assumes column-major order. * @param {Number} [startingIndex=0] The offset into the array of the first element, which corresponds to first column first row position in the matrix. * @param {Matrix4} [result] The object onto which to store the result. * @@ -236,7 +236,7 @@ define([ * @memberof Matrix4 * @function * - * @param {Array} values The column-major order array. + * @param {Number[]} values The column-major order array. * @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. */ @@ -255,7 +255,7 @@ define([ * The resulting matrix will be in column-major order. * @memberof Matrix4 * - * @param {Array} values The row-major order array. + * @param {Number[]} values The row-major order array. * @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. */ @@ -983,8 +983,8 @@ define([ * @memberof Matrix4 * * @param {Matrix4} matrix The matrix to use.. - * @param {Array} [result] The Array onto which to store the result. - * @returns {Array} The modified Array parameter or a new Array instance if one was not provided. + * @param {Number[]} [result] The Array onto which to store the result. + * @returns {Number[]} The modified Array parameter or a new Array instance if one was not provided. * * @example * //create an array from an instance of Matrix4 diff --git a/Source/Core/NearFarScalar.js b/Source/Core/NearFarScalar.js index af395c020311..62af3ee43f4b 100644 --- a/Source/Core/NearFarScalar.js +++ b/Source/Core/NearFarScalar.js @@ -84,7 +84,7 @@ define([ * @memberof NearFarScalar * * @param {NearFarScalar} value The value to pack. - * @param {Array} array The array to pack into. + * @param {Number[]} array The array to pack into. * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. */ NearFarScalar.pack = function(value, array, startingIndex) { @@ -109,7 +109,7 @@ define([ * Retrieves an instance from a packed array. * @memberof NearFarScalar * - * @param {Array} array The packed array. + * @param {Number[]} array The packed array. * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. * @param {NearFarScalar} [result] The object into which to store the result. */ diff --git a/Source/Core/ObjectOrientedBoundingBox.js b/Source/Core/ObjectOrientedBoundingBox.js index 266656aac4e7..2273e931c600 100644 --- a/Source/Core/ObjectOrientedBoundingBox.js +++ b/Source/Core/ObjectOrientedBoundingBox.js @@ -74,7 +74,7 @@ define([ * Reference: http://gamma.cs.unc.edu/users/gottschalk/main.pdf * @memberof ObjectOrientedBoundingBox * - * @param {Array} positions List of {@link Cartesian3} points that the bounding box will enclose. + * @param {Cartesian3[]} positions List of {@link Cartesian3} points that the bounding box will enclose. * @param {ObjectOrientedBoundingBox} [result] The object onto which to store the result. * @returns {ObjectOrientedBoundingBox} The modified result parameter or a new ObjectOrientedBoundingBox instance if one was not provided. * diff --git a/Source/Core/Occluder.js b/Source/Core/Occluder.js index c8ce9500d6a8..e5d54063d09e 100644 --- a/Source/Core/Occluder.js +++ b/Source/Core/Occluder.js @@ -334,7 +334,7 @@ define([ * * @param {BoundingSphere} occluderBoundingSphere The bounding sphere surrounding the occluder. * @param {Cartesian3} occludeePosition The point where the occludee (bounding sphere of radius 0) is located. - * @param {Array} positions List of altitude points on the horizon near the surface of the occluder. + * @param {Cartesian3[]} positions List of altitude points on the horizon near the surface of the occluder. * * @exception {DeveloperError} positions must contain at least one element. * @exception {DeveloperError} occludeePosition must have a value other than occluderBoundingSphere.center. diff --git a/Source/Core/Packable.js b/Source/Core/Packable.js index cc5004275c81..70c6aedcbfa9 100644 --- a/Source/Core/Packable.js +++ b/Source/Core/Packable.js @@ -7,7 +7,7 @@ define([ /** * Static interface for types which can store their values as packed - * elements in an array. These methods and properties are expected to be + * elements in an array. These methods and properties are expected to be * defined on a constructor function. * * @exports Packable @@ -27,7 +27,7 @@ define([ * @function * * @param {Object} value The value to pack. - * @param {Array} array The array to pack into. + * @param {Number[]} array The array to pack into. * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. */ pack : DeveloperError.throwInstantiationError, @@ -37,7 +37,7 @@ define([ * @memberof Packable * @function * - * @param {Array} array The packed array. + * @param {Number[]} array The packed array. * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. * @param {Object} [result] The object into which to store the result. */ diff --git a/Source/Core/PackableForInterpolation.js b/Source/Core/PackableForInterpolation.js index 47da5295634b..9bd1840fa5bd 100644 --- a/Source/Core/PackableForInterpolation.js +++ b/Source/Core/PackableForInterpolation.js @@ -26,10 +26,10 @@ define([ * @memberof PackableForInterpolation * @function * - * @param {Array} packedArray The packed array. + * @param {Number[]} packedArray The packed array. * @param {Number} [startingIndex=0] The index of the first element to be converted. * @param {Number} [lastIndex=packedArray.length] The index of the last element to be converted. - * @param {Array} [result] The object into which to store the result. + * @param {Number[]} [result] The object into which to store the result. */ convertPackedArrayForInterpolation : DeveloperError.throwInstantiationError, @@ -38,8 +38,8 @@ define([ * @memberof PackableForInterpolation * @function * - * @param {Array} array The original packed array. - * @param {Array} sourceArray The converted array. + * @param {Number[]} array The original packed array. + * @param {Number[]} sourceArray The converted array. * @param {Number} [startingIndex=0] The startingIndex used to convert the array. * @param {Number} [lastIndex=packedArray.length] The lastIndex used to convert the array. * @param {Object} [result] The object into which to store the result. diff --git a/Source/Core/PolygonGeometry.js b/Source/Core/PolygonGeometry.js index fe8e9fe7fa68..0fc5d4478e48 100644 --- a/Source/Core/PolygonGeometry.js +++ b/Source/Core/PolygonGeometry.js @@ -594,7 +594,7 @@ define([ * * @memberof PolygonGeometry * - * @param {Array} options.positions An array of positions that defined the corner points of the polygon. + * @param {Cartesian3[]} options.positions An array of positions that defined the corner points of the polygon. * @param {Number} [options.height=0.0] The height of the polygon. * @param {Number} [options.extrudedHeight] The height of the polygon extrusion. * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. diff --git a/Source/Core/PolygonOutlineGeometry.js b/Source/Core/PolygonOutlineGeometry.js index d6c06203a5d7..6abfe89495c4 100644 --- a/Source/Core/PolygonOutlineGeometry.js +++ b/Source/Core/PolygonOutlineGeometry.js @@ -307,7 +307,7 @@ define([ * * @memberof PolygonOutlineGeometry * - * @param {Array} options.positions An array of positions that defined the corner points of the polygon. + * @param {Cartesian3[]} options.positions An array of positions that defined the corner points of the polygon. * @param {Number} [options.height=0.0] The height of the polygon. * @param {Number} [options.extrudedHeight] The height of the polygon extrusion. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference. diff --git a/Source/Core/PolygonPipeline.js b/Source/Core/PolygonPipeline.js index 606923c10130..e420bf172652 100644 --- a/Source/Core/PolygonPipeline.js +++ b/Source/Core/PolygonPipeline.js @@ -44,7 +44,7 @@ define([ /** * Returns the index of the vertex with the maximum X value. * - * @param {Array} positions An array of the Cartesian points defining the polygon's vertices. + * @param {Cartesian2[]} positions An array of the Cartesian points defining the polygon's vertices. * @returns {Number} The index of the positions with the maximum X value. * * @private @@ -64,7 +64,7 @@ define([ /** * Returns the index of the ring that contains the rightmost vertex. * - * @param {Array} rings An array of arrays of Cartesians. Each array contains the vertices defining a polygon. + * @param {Cartesian2[]} rings An array of arrays of Cartesians. Each array contains the vertices defining a polygon. * @returns {Number} The index of the ring containing the rightmost vertex. * * @private @@ -86,8 +86,8 @@ define([ /** * Returns a list containing the reflex vertices for a given polygon. * - * @param {Array} polygon An array of Cartesian elements defining the polygon. - * @returns {Array} + * @param {Cartesian2[]} polygon An array of Cartesian elements defining the polygon. + * @returns {Cartesian2[]} * * @private */ @@ -108,7 +108,7 @@ define([ /** * Returns true if the given point is contained in the list of positions. * - * @param {Array} positions A list of Cartesian elements defining a polygon. + * @param {Cartesian2[]} positions A list of Cartesian elements defining a polygon. * @param {Cartesian2} point The point to check. * @returns {Number} The index of point in positions or -1 if it was not found. * @@ -127,8 +127,8 @@ define([ * Given a point inside a polygon, find the nearest point directly to the right that lies on one of the polygon's edges. * * @param {Cartesian2} point A point inside the polygon defined by ring. - * @param {Array} ring A list of Cartesian points defining a polygon. - * @param {Array} [edgeIndices] An array containing the indices two endpoints of the edge containing the intersection. + * @param {Cartesian2[]} ring A list of Cartesian points defining a polygon. + * @param {Number[]} [edgeIndices] An array containing the indices two endpoints of the edge containing the intersection. * * @returns {Cartesian2} The intersection point. * @@ -188,8 +188,8 @@ define([ * Given an outer ring and multiple inner rings, determine the point on the outer ring that is visible * to the rightmost vertex of the rightmost inner ring. * - * @param {Array} outerRing An array of Cartesian points defining the outer boundary of the polygon. - * @param {Array} innerRings An array of arrays of Cartesian points, where each array represents a hole in the polygon. + * @param {Cartesian2[]} outerRing An array of Cartesian points defining the outer boundary of the polygon. + * @param {Cartesian2[]} innerRings An array of arrays of Cartesian points, where each array represents a hole in the polygon. * @returns {Number} The index of the vertex in outerRing that is mutually visible to the rightmost vertex in inenrRing. * * @private @@ -252,10 +252,10 @@ define([ * Given a polygon defined by an outer ring with one or more inner rings (holes), return a single list of points representing * a polygon with the rightmost hole added to it. The added hole is removed from innerRings. * - * @param {Array} outerRing An array of Cartesian points defining the outer boundary of the polygon. - * @param {Array} innerRings An array of arrays of Cartesian points, where each array represents a hole in the polygon. + * @param {Cartesian2[]} outerRing An array of Cartesian points defining the outer boundary of the polygon. + * @param {Cartesian2[]} innerRings An array of arrays of Cartesian points, where each array represents a hole in the polygon. * - * @returns {Array} A single list of Cartesian points defining the polygon, including the eliminated inner ring. + * @returns {Cartesian2[]} A single list of Cartesian points defining the polygon, including the eliminated inner ring. * * @private */ @@ -350,7 +350,7 @@ define([ * * @param {Number} a1i Index of first vertex. * @param {Number} a2i Index of second vertex. - * @param {Array} pArray Array of { position, index } objects representing the polygon. + * @param {Object{position: Cartesian2, index: Number}[]} pArray Array of { position, index } objects representing the polygon. * @returns {Boolean} If true, a cut from the first vertex to the second is internal and does not cross any other sides. * * @private @@ -367,7 +367,7 @@ define([ * * @param {Number} a1i Index of first vertex. * @param {Number} a2i Index of second vertex. - * @param {Array} pArray Array of { position, index } objects representing the polygon. + * @param {Object{position: Cartesian2, index: Number}[]} pArray Array of { position, index } objects representing the polygon. * @returns {Boolean} If true, the cut formed between the two vertices is internal to the angle at vertex 1 * * @private @@ -607,7 +607,7 @@ define([ * * @param {Cartesian2} a1 Position of first vertex. * @param {Cartesian2} a2 Position of second vertex. - * @param {Array} pArray Array of { position, index } objects representing polygon. + * @param {Object{position: Cartesian2, index: Number}[]} pArray Array of { position, index } objects representing polygon. * @returns {Boolean} The segment between a1 and a2 intersect another polygon side. * * @private @@ -703,8 +703,8 @@ define([ * which form a clean cut through the polygon, and divides the polygon * then continues to "chop" the two resulting polygons. * - * @param {Array} nodeArray Array of { position, index } objects representing polygon - * @returns {Array} Index array representing triangles that fill the polygon + * @param {Object{position: Cartesian2, index: Number}[]} nodeArray Array of { position, index } objects representing polygon + * @returns {Number[]} Index array representing triangles that fill the polygon * * @exception {DeveloperError} Invalid polygon: must have at least three vertices. * @@ -850,8 +850,8 @@ define([ /** * Triangulate a polygon * - * @param {Array} positions - Cartesian2 array containing the vertices of the polygon - * @returns {Array} - Index array representing triangles that fill the polygon + * @param {Cartesian2[]} positions - Cartesian2 array containing the vertices of the polygon + * @returns {Number[]} - Index array representing triangles that fill the polygon * * @exception {DeveloperError} At least three positions are required. */ @@ -891,8 +891,8 @@ define([ /** * Subdivides positions and raises points to the surface of the ellipsoid. * - * @param {Array} positions An array of {@link Cartesian3} positions of the polygon. - * @param {Array} indices An array of indices that determines the triangles in the polygon. + * @param {Cartesian3[]} positions An array of {@link Cartesian3} positions of the polygon. + * @param {Number[]} indices An array of indices that determines the triangles in the polygon. * @param {Number} [granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. * * @exception {DeveloperError} At least three indices are required. @@ -1104,8 +1104,8 @@ define([ * Given a polygon defined by an outer ring with one or more inner rings (holes), return a single list of points representing * a polygon defined by the outer ring with the inner holes removed. * - * @param {Array} outerRing An array of Cartesian points defining the outer boundary of the polygon. - * @param {Array} innerRings An array of arrays of Cartesian points, where each array represents a hole in the polygon. + * @param {Cartesian2[]} outerRing An array of Cartesian points defining the outer boundary of the polygon. + * @param {Cartesian2[]} innerRings An array of arrays of Cartesian points, where each array represents a hole in the polygon. * * @returns A single list of Cartesian points defining the polygon, including the eliminated inner ring. * diff --git a/Source/Core/PolylineGeometry.js b/Source/Core/PolylineGeometry.js index 34578807e3a5..ca99f6783a5f 100644 --- a/Source/Core/PolylineGeometry.js +++ b/Source/Core/PolylineGeometry.js @@ -39,9 +39,9 @@ define([ * @alias PolylineGeometry * @constructor * - * @param {Array} options.positions An array of {@link Cartesian3} defining the positions in the polyline as a line strip. + * @param {Cartesian3[]} options.positions An array of {@link Cartesian3} defining the positions in the polyline as a line strip. * @param {Number} [options.width=1.0] The width in pixels. - * @param {Array} [options.colors] An Array of {@link Color} defining the per vertex or per segment colors. + * @param {Color[]} [options.colors] An Array of {@link Color} defining the per vertex or per segment colors. * @param {Boolean} [options.colorsPerVertex=false] A boolean that determines whether the colors will be flat across each segment of the line or interpolated across the vertices. * * @exception {DeveloperError} At least two positions are required. diff --git a/Source/Core/PolylinePipeline.js b/Source/Core/PolylinePipeline.js index 415a48f15ea8..0a252a35b064 100644 --- a/Source/Core/PolylinePipeline.js +++ b/Source/Core/PolylinePipeline.js @@ -96,7 +96,7 @@ define([ * Breaks a {@link Polyline} into segments such that it does not cross the ±180 degree meridian of an ellipsoid. * @memberof PolylinePipeline * - * @param {Array} positions The polyline's Cartesian positions. + * @param {Cartesian3[]} positions The polyline's Cartesian positions. * @param {Matrix4} [modelMatrix=Matrix4.IDENTITY] The polyline's model matrix. Assumed to be an affine * transformation matrix, where the upper left 3x3 elements are a rotation matrix, and * the upper three elements in the fourth column are the translation. The bottom row is assumed to be [0, 0, 0, 1]. @@ -178,9 +178,9 @@ define([ * * @memberof PolylinePipeline * - * @param {Array} positions The array of {Cartesian3} positions. + * @param {Cartesian3[]} positions The array of {Cartesian3} positions. * - * @returns {Array} A new array of positions with no adjacent duplicate positions. Positions are shallow copied. + * @returns {Cartesian3[]} A new array of positions with no adjacent duplicate positions. Positions are shallow copied. * * @example * // Returns [(1.0, 1.0, 1.0), (2.0, 2.0, 2.0)] @@ -222,11 +222,11 @@ define([ * * @memberof PolylinePipeline * - * @param {Array} positions The array of positions of type {Cartesian3}. + * @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. * - * @returns {Array} A new array of positions of type {Number} that have been subdivided and raised to the surface of the ellipsoid. + * @returns {Number[]} A new array of positions of type {Number} that have been subdivided and raised to the surface of the ellipsoid. * * @example * var positions = Cesium.Cartesian3.fromDegreesArray([ @@ -269,12 +269,12 @@ define([ * * @memberof PolylinePipeline * - * @param {Array} positions The array of type {Number} representing positions. - * @param {Number|Array} height A number or array of numbers representing the heights of each position. + * @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 {Array} [result] An array to place the resultant positions in. + * @param {Number[]} [result] An array to place the resultant positions in. * - * @returns {Array} The array of positions scaled to height. + * @returns {Number[]} The array of positions scaled to height. * @exception {DeveloperError} positions must be defined. * @exception {DeveloperError} height must be defined. diff --git a/Source/Core/PolylineVolumeGeometry.js b/Source/Core/PolylineVolumeGeometry.js index 37849419ca34..cb47ae6f27a2 100644 --- a/Source/Core/PolylineVolumeGeometry.js +++ b/Source/Core/PolylineVolumeGeometry.js @@ -178,7 +178,7 @@ define([ * @alias PolylineVolumeGeometry * @constructor * - * @param {Array} options.polylinePositions An array of {@link Cartesain3} positions that define the center of the polyline volume. + * @param {Cartesian3[]} options.polylinePositions An array of {@link Cartesain3} positions that define the center of the polyline volume. * @param {Number} options.shapePositions An array of {@link Cartesian2} 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. diff --git a/Source/Core/PolylineVolumeOutlineGeometry.js b/Source/Core/PolylineVolumeOutlineGeometry.js index d4b0a9d15847..70d97fe30075 100644 --- a/Source/Core/PolylineVolumeOutlineGeometry.js +++ b/Source/Core/PolylineVolumeOutlineGeometry.js @@ -95,7 +95,7 @@ define([ * @alias PolylineVolumeOutlineGeometry * @constructor * - * @param {Array} options.polylinePositions An array of {Cartesain3} positions that define the center of the polyline volume. + * @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 {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. diff --git a/Source/Core/QuadraticRealPolynomial.js b/Source/Core/QuadraticRealPolynomial.js index 4cc17b326ae5..ad49bc32ae77 100644 --- a/Source/Core/QuadraticRealPolynomial.js +++ b/Source/Core/QuadraticRealPolynomial.js @@ -57,7 +57,7 @@ define([ * @param {Number} a The coefficient of the 2nd order monomial. * @param {Number} b The coefficient of the 1st order monomial. * @param {Number} c The coefficient of the 0th order monomial. - * @returns {Array} The real valued roots. + * @returns {Number[]} The real valued roots. */ QuadraticRealPolynomial.realRoots = function(a, b, c) { //>>includeStart('debug', pragmas.debug); diff --git a/Source/Core/QuarticRealPolynomial.js b/Source/Core/QuarticRealPolynomial.js index d5f6107e3ab8..fa448f28af4f 100644 --- a/Source/Core/QuarticRealPolynomial.js +++ b/Source/Core/QuarticRealPolynomial.js @@ -254,7 +254,7 @@ define([ * @param {Number} c The coefficient of the 2nd order monomial. * @param {Number} d The coefficient of the 1st order monomial. * @param {Number} e The coefficient of the 0th order monomial. - * @returns {Array} The real valued roots. + * @returns {Number[]} The real valued roots. */ QuarticRealPolynomial.realRoots = function(a, b, c, d, e) { //>>includeStart('debug', pragmas.debug); diff --git a/Source/Core/Quaternion.js b/Source/Core/Quaternion.js index 105fa2785b94..5dd5b35c9165 100644 --- a/Source/Core/Quaternion.js +++ b/Source/Core/Quaternion.js @@ -194,7 +194,7 @@ define([ * @memberof Quaternion * * @param {Quaternion} value The value to pack. - * @param {Array} array The array to pack into. + * @param {Number[]} array The array to pack into. * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. */ Quaternion.pack = function(value, array, startingIndex) { @@ -220,7 +220,7 @@ define([ * Retrieves an instance from a packed array. * @memberof Quaternion * - * @param {Array} array The packed array. + * @param {Number[]} array The packed array. * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. * @param {Quaternion} [result] The object into which to store the result. */ @@ -253,10 +253,10 @@ define([ * Converts a packed array into a form suitable for interpolation. * @memberof Quaternion * - * @param {Array} packedArray The packed array. + * @param {Number[]} packedArray The packed array. * @param {Number} [startingIndex=0] The index of the first element to be converted. * @param {Number} [lastIndex=packedArray.length] The index of the last element to be converted. - * @param {Array} [result] The object into which to store the result. + * @param {Number[]} [result] The object into which to store the result. */ Quaternion.convertPackedArrayForInterpolation = function(packedArray, startingIndex, lastIndex, result) { Quaternion.unpack(packedArray, lastIndex * 4, sampledQuaternionQuaternion0Conjugate); @@ -284,8 +284,8 @@ define([ * Retrieves an instance from a packed array converted with {@link convertPackedArrayForInterpolation}. * @memberof Quaternion * - * @param {Array} array The original packed array. - * @param {Array} sourceArray The converted array. + * @param {Number[]} array The original packed array. + * @param {Number[]} sourceArray The converted array. * @param {Number} [startingIndex=0] The startingIndex used to convert the array. * @param {Number} [lastIndex=packedArray.length] The lastIndex used to convert the array. * @param {Quaternion} [result] The object into which to store the result. diff --git a/Source/Core/QuaternionSpline.js b/Source/Core/QuaternionSpline.js index 4f07541f2c06..2764d7f4fe66 100644 --- a/Source/Core/QuaternionSpline.js +++ b/Source/Core/QuaternionSpline.js @@ -69,9 +69,9 @@ define([ * @alias QuaternionSpline * @constructor * - * @param {Array} options.times An array of strictly increasing, unit-less, floating-point times at each point. + * @param {Number[]} options.times An array of strictly increasing, unit-less, floating-point times at each point. * The values are in no way connected to the clock time. They are the parameterization for the curve. - * @param {Array} options.points The array of {@link Quaternion} control points. + * @param {Quaternion[]} options.points The array of {@link Quaternion} control points. * @param {Quaternion} [options.firstInnerQuadrangle] The inner quadrangle of the curve at the first control point. * If the inner quadrangle is not given, it will be estimated. * @param {Quaternion} [options.lastInnerQuadrangle] The inner quadrangle of the curve at the last control point. @@ -122,7 +122,7 @@ define([ * * @memberof QuaternionSpline.prototype * - * @type {Array} + * @type {Number[]} * @readonly */ times : { @@ -136,7 +136,7 @@ define([ * * @memberof QuaternionSpline.prototype * - * @type {Array} + * @type {Quaternion[]} * @readonly */ points : { @@ -150,7 +150,7 @@ define([ * * @memberof QuaternionSpline.prototype * - * @type {Array} + * @type {Quaternion[]} * @readonly */ innerQuadrangles : { diff --git a/Source/Core/Rectangle.js b/Source/Core/Rectangle.js index d22f40194209..7b4e7475f1ee 100644 --- a/Source/Core/Rectangle.js +++ b/Source/Core/Rectangle.js @@ -102,7 +102,7 @@ define([ * Creates the smallest possible Rectangle that encloses all positions in the provided array. * @memberof Rectangle * - * @param {Array} cartographics The list of Cartographic instances. + * @param {Cartographic[]} cartographics The list of Cartographic instances. * @param {Rectangle} [result] The object onto which to store the result, or undefined if a new instance should be created. * @returns {Rectangle} The modified result parameter or a new Rectangle instance if none was provided. */ @@ -148,7 +148,7 @@ define([ * @memberof Rectangle * * @param {Rectangle} value The value to pack. - * @param {Array} array The array to pack into. + * @param {Number[]} array The array to pack into. * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. */ Rectangle.pack = function(value, array, startingIndex) { @@ -174,7 +174,7 @@ define([ * Retrieves an instance from a packed array. * @memberof Rectangle * - * @param {Array} array The packed array. + * @param {Number[]} array The packed array. * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. * @param {Rectangle} [result] The object into which to store the result. */ @@ -550,8 +550,8 @@ define([ * @param {Rectangle} rectangle The rectangle to subsample. * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid to use. * @param {Number} [surfaceHeight=0.0] The height of the rectangle above the ellipsoid. - * @param {Array} [result] The array of Cartesians onto which to store the result. - * @returns {Array} The modified result parameter or a new Array of Cartesians instances if none was provided. + * @param {Cartesian3[]} [result] The array of Cartesians onto which to store the result. + * @returns {Cartesian3[]} The modified result parameter or a new Array of Cartesians instances if none was provided. */ Rectangle.subsample = function(rectangle, ellipsoid, surfaceHeight, result) { //>>includeStart('debug', pragmas.debug); diff --git a/Source/Core/SimplePolylineGeometry.js b/Source/Core/SimplePolylineGeometry.js index 88631594abe7..c14a0396bf90 100644 --- a/Source/Core/SimplePolylineGeometry.js +++ b/Source/Core/SimplePolylineGeometry.js @@ -34,8 +34,8 @@ define([ * @alias SimplePolylineGeometry * @constructor * - * @param {Array} options.positions An array of {@link Cartesian3} defining the positions in the polyline as a line strip. - * @param {Array} [options.colors] An Array of {@link Color} defining the per vertex or per segment colors. + * @param {Cartesian3[]} options.positions An array of {@link Cartesian3} defining the positions in the polyline as a line strip. + * @param {Color[]} [options.colors] An Array of {@link Color} defining the per vertex or per segment colors. * @param {Boolean} [options.colorsPerVertex=false] A boolean that determines whether the colors will be flat across each segment of the line or interpolated across the vertices. * * @exception {DeveloperError} At least two positions are required. diff --git a/Source/Core/Spline.js b/Source/Core/Spline.js index 6b7f8d0bd6c2..ebe5839ec5a0 100644 --- a/Source/Core/Spline.js +++ b/Source/Core/Spline.js @@ -26,14 +26,14 @@ define([ var Spline = function() { /** * An array of times for the control points. - * @type {Array} + * @type {Number[]} * @default undefined */ this.times = undefined; /** * An array of control points. - * @type {Array} + * @type {Cartesian3[]|Quaternion[]} * @default undefined */ this.points = undefined; diff --git a/Source/Core/TaskProcessor.js b/Source/Core/TaskProcessor.js index cdc1d8c96fc0..f98590eafc01 100644 --- a/Source/Core/TaskProcessor.js +++ b/Source/Core/TaskProcessor.js @@ -176,7 +176,7 @@ define([ * finished. * * @param {*} parameters Any input data that will be posted to the worker. - * @param {Array} [transferableObjects] An array of objects contained in parameters that should be + * @param {Object[]} [transferableObjects] An array of objects contained in parameters that should be * transferred to the worker instead of copied. * @returns {Promise} Either a promise that will resolve to the result when available, or undefined * if there are too many active tasks, diff --git a/Source/Core/Tipsify.js b/Source/Core/Tipsify.js index 038b3d8048e9..970c4d44637e 100644 --- a/Source/Core/Tipsify.js +++ b/Source/Core/Tipsify.js @@ -28,7 +28,7 @@ define([ /** * Calculates the average cache miss ratio (ACMR) for a given set of indices. * - * @param {Array} options.indices Lists triads of numbers corresponding to the indices of the vertices + * @param {Number[]} options.indices Lists triads of numbers corresponding to the indices of the vertices * in the vertex buffer that define the geometry's triangles. * @param {Number} [options.maximumIndex] The maximum value of the elements in args.indices. * If not supplied, this value will be computed. @@ -106,7 +106,7 @@ define([ /** * Optimizes triangles for the post-vertex shader cache. * - * @param {Array} options.indices Lists triads of numbers corresponding to the indices of the vertices + * @param {Number[]} options.indices Lists triads of numbers corresponding to the indices of the vertices * in the vertex buffer that define the geometry's triangles. * @param {Number} [options.maximumIndex] The maximum value of the elements in args.indices. * If not supplied, this value will be computed. @@ -115,7 +115,7 @@ define([ * @exception {DeveloperError} indices length must be a multiple of three. * @exception {DeveloperError} cacheSize must be greater than two. * - * @returns {Array} A list of the input indices in an optimized order. + * @returns {Number[]} A list of the input indices in an optimized order. * * @example * var indices = [0, 1, 2, 3, 4, 5]; diff --git a/Source/Core/TridiagonalSystemSolver.js b/Source/Core/TridiagonalSystemSolver.js index 389e79aa5a35..12191c603607 100644 --- a/Source/Core/TridiagonalSystemSolver.js +++ b/Source/Core/TridiagonalSystemSolver.js @@ -20,16 +20,16 @@ define([ /** * Solves a tridiagonal system of linear equations. * - * @param {Array} diagonal An array with length n that contains the diagonal of the coefficient matrix. - * @param {Array} lower An array with length n - 1 that contains the lower diagonal of the coefficient matrix. - * @param {Array} upper An array with length n - 1 that contains the upper diagonal of the coefficient matrix. - * @param {Array} right An array of Cartesians with length n that is the right side of the system of equations. + * @param {Number[]} diagonal An array with length n that contains the diagonal of the coefficient matrix. + * @param {Number[]} lower An array with length n - 1 that contains the lower diagonal of the coefficient matrix. + * @param {Number[]} upper An array with length n - 1 that contains the upper diagonal of the coefficient matrix. + * @param {Cartesian3[]} right An array of Cartesians with length n that is the right side of the system of equations. * * @exception {DeveloperError} diagonal and right must have the same lengths. * @exception {DeveloperError} lower and upper must have the same lengths. * @exception {DeveloperError} lower and upper must be one less than the length of diagonal. * - * @returns {Array} An array of Cartesians with length n that is the solution to the tridiagonal system of equations. + * @returns {Cartesian3[]} An array of Cartesians with length n that is the solution to the tridiagonal system of equations. * * @performance Linear time. * diff --git a/Source/Core/WallGeometry.js b/Source/Core/WallGeometry.js index e31d60b13d4e..d2c889ba3684 100644 --- a/Source/Core/WallGeometry.js +++ b/Source/Core/WallGeometry.js @@ -49,11 +49,11 @@ define([ * @alias WallGeometry * @constructor * - * @param {Array} positions An array of Cartesian objects, which are the points of the wall. + * @param {Cartesian3[]} positions An array of Cartesian objects, which are the points of the wall. * @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 {Array} [maximumHeights] An array parallel to positions that give the maximum height of the + * @param {Number[]} [maximumHeights] An array parallel to positions that give the maximum height of the * wall at positions. If undefined, the height of each position in used. - * @param {Array} [minimumHeights] An array parallel to positions that give the minimum height of the + * @param {Number[]} [minimumHeights] An array parallel to positions that give the minimum height of the * wall at positions. If undefined, the height at each position is 0.0. * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid for coordinate manipulation * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. @@ -115,7 +115,7 @@ define([ * * @memberof WallGeometry * - * @param {Array} positions An array of Cartesian objects, which are the points of the wall. + * @param {Cartesian3[]} positions An array of Cartesian objects, which are the points of the wall. * @param {Number} [maximumHeight] A constant that defines the maximum height of the * wall at positions. If undefined, the height of each position in used. * @param {Number} [minimumHeight] A constant that defines the minimum height of the diff --git a/Source/Core/WallOutlineGeometry.js b/Source/Core/WallOutlineGeometry.js index b79fca6fc9ce..a8eee79c8a13 100644 --- a/Source/Core/WallOutlineGeometry.js +++ b/Source/Core/WallOutlineGeometry.js @@ -41,11 +41,11 @@ define([ * @alias WallOutlineGeometry * @constructor * - * @param {Array} positions An array of Cartesian objects, which are the points of the wall. + * @param {Cartesian3[]} positions An array of Cartesian objects, which are the points of the wall. * @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 {Array} [maximumHeights] An array parallel to positions that give the maximum height of the + * @param {Number[]} [maximumHeights] An array parallel to positions that give the maximum height of the * wall at positions. If undefined, the height of each position in used. - * @param {Array} [minimumHeights] An array parallel to positions that give the minimum height of the + * @param {Number[]} [minimumHeights] An array parallel to positions that give the minimum height of the * wall at positions. If undefined, the height at each position is 0.0. * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid for coordinate manipulation * @@ -104,7 +104,7 @@ define([ * * @memberof WallOutlineGeometry * - * @param {Array} positions An array of Cartesian objects, which are the points of the wall. + * @param {Cartesian3[]} positions An array of Cartesian objects, which are the points of the wall. * @param {Number} [maximumHeight] A constant that defines the maximum height of the * wall at positions. If undefined, the height of each position in used. * @param {Number} [minimumHeight] A constant that defines the minimum height of the diff --git a/Source/DynamicScene/CompositeDynamicObjectCollection.js b/Source/DynamicScene/CompositeDynamicObjectCollection.js index 6d1e0988c3a1..add108997e7d 100644 --- a/Source/DynamicScene/CompositeDynamicObjectCollection.js +++ b/Source/DynamicScene/CompositeDynamicObjectCollection.js @@ -120,7 +120,7 @@ define([ * @alias CompositeDynamicObjectCollection * @constructor * - * @param {Array} [collections] The initial list of DynamicObjectCollection instances to merge. + * @param {DynamicObjectCollection[]} [collections] The initial list of DynamicObjectCollection instances to merge. */ var CompositeDynamicObjectCollection = function(collections) { this._composite = new DynamicObjectCollection(); @@ -439,7 +439,7 @@ define([ * The array should not be modified directly. * @memberof CompositeDynamicObjectCollection * - * @returns {Array} the array of DynamicObject instances in the collection. + * @returns {DynamicObject[]} the array of DynamicObject instances in the collection. */ CompositeDynamicObjectCollection.prototype.getObjects = function() { return this._composite.getObjects(); diff --git a/Source/DynamicScene/DynamicObjectCollection.js b/Source/DynamicScene/DynamicObjectCollection.js index bffdc9f6e970..07b8eb786576 100644 --- a/Source/DynamicScene/DynamicObjectCollection.js +++ b/Source/DynamicScene/DynamicObjectCollection.js @@ -89,8 +89,8 @@ define([ * @function * * @param {DynamicObjectCollection} collection The collection that triggered the event. - * @param {Array} added The array of {@link DynamicObject} instances that have been added to the collection. - * @param {Array} removed The array of {@link DynamicObject} instances that have been removed from the collection. + * @param {DynamicObject[]} added The array of {@link DynamicObject} instances that have been added to the collection. + * @param {DynamicObject[]} removed The array of {@link DynamicObject} instances that have been removed from the collection. */ DynamicObjectCollection.collectionChangedEventCallback = undefined; @@ -281,7 +281,7 @@ define([ * The array should not be modified directly. * @memberof DynamicObjectCollection * - * @returns {Array} the array of DynamicObject instances in the collection. + * @returns {DynamicObject[]} the array of DynamicObject instances in the collection. */ DynamicObjectCollection.prototype.getObjects = function() { return this._objects.values; diff --git a/Source/DynamicScene/PositionPropertyArray.js b/Source/DynamicScene/PositionPropertyArray.js index b25722db9d25..6970f7c17804 100644 --- a/Source/DynamicScene/PositionPropertyArray.js +++ b/Source/DynamicScene/PositionPropertyArray.js @@ -26,7 +26,7 @@ define([ * @alias PositionPropertyArray * @constructor * - * @param {Array} [value] An array of Property instances. + * @param {Property[]} [value] An array of Property instances. */ var PositionPropertyArray = function(value, referenceFrame) { this._value = undefined; @@ -89,8 +89,8 @@ define([ * @memberof PositionPropertyArray * * @param {JulianDate} [time] The time for which to retrieve the value. This parameter is unused since the value does not change with respect to time. - * @param {Array} [result] The object to store the value into, if omitted, a new instance is created and returned. - * @returns {Array} The modified result parameter or a new instance if the result parameter was not supplied. + * @param {Cartesian3[]} [result] The object to store the value into, if omitted, a new instance is created and returned. + * @returns {Cartesian3[]} The modified result parameter or a new instance if the result parameter was not supplied. */ PositionPropertyArray.prototype.getValue = function(time, result) { return this.getValueInReferenceFrame(time, ReferenceFrame.FIXED, result); @@ -144,7 +144,7 @@ define([ * If the value is an object, the object must provide clone and equals functions. * @memberof PositionPropertyArray * - * @param {Array} value An array of Property instances. + * @param {Property[]} value An array of Property instances. */ PositionPropertyArray.prototype.setValue = function(value) { var eventHelper = this._eventHelper; diff --git a/Source/DynamicScene/PropertyArray.js b/Source/DynamicScene/PropertyArray.js index dc38e7f28667..255d30706275 100644 --- a/Source/DynamicScene/PropertyArray.js +++ b/Source/DynamicScene/PropertyArray.js @@ -22,7 +22,7 @@ define([ * @alias PropertyArray * @constructor * - * @param {Array} [value] An array of Property instances. + * @param {Property[]} [value] An array of Property instances. */ var PropertyArray = function(value) { this._value = undefined; @@ -72,8 +72,8 @@ define([ * @memberof PropertyArray * * @param {JulianDate} [time] The time for which to retrieve the value. This parameter is unused since the value does not change with respect to time. - * @param {Array} [result] The object to store the value into, if omitted, a new instance is created and returned. - * @returns {Array} The modified result parameter or a new instance if the result parameter was not supplied. + * @param {Object[]} [result] The object to store the value into, if omitted, a new instance is created and returned. + * @returns {Object[]} The modified result parameter or a new instance if the result parameter was not supplied. */ PropertyArray.prototype.getValue = function(time, result) { //>>includeStart('debug', pragmas.debug); @@ -110,7 +110,7 @@ define([ * Sets the value of the property. * @memberof PropertyArray * - * @param {Array} value An array of Property instances. + * @param {Property[]} value An array of Property instances. */ PropertyArray.prototype.setValue = function(value) { var eventHelper = this._eventHelper; diff --git a/Source/DynamicScene/SampledPositionProperty.js b/Source/DynamicScene/SampledPositionProperty.js index 00f61c30fc45..4e34616c87d6 100644 --- a/Source/DynamicScene/SampledPositionProperty.js +++ b/Source/DynamicScene/SampledPositionProperty.js @@ -167,8 +167,8 @@ define([ * Adds an array of samples * @memberof SampledPositionProperty * - * @param {Array} times An array of JulianDate instances where each index is a sample time. - * @param {Array} values The array of Cartesian3 instances, where each value corresponds to the provided times index. + * @param {JulianDate[]} times An array of JulianDate instances where each index is a sample time. + * @param {Cartesian3[]} values The array of Cartesian3 instances, where each value corresponds to the provided times index. * * @exception {DeveloperError} times and values must be the same length.. */ @@ -180,7 +180,7 @@ define([ * Adds samples as a single packed array where each new sample is represented as a date, followed by the packed representation of the corresponding value. * @memberof SampledPositionProperty * - * @param {Array} packedSamples The array of packed samples. + * @param {Number[]} packedSamples The array of packed samples. * @param {JulianDate} [epoch] If any of the dates in packedSamples are numbers, they are considered an offset from this epoch, in seconds. */ SampledPositionProperty.prototype.addSamplesPackedArray = function(data, epoch) { diff --git a/Source/DynamicScene/SampledProperty.js b/Source/DynamicScene/SampledProperty.js index 9167a7e49d03..4efd988d8d98 100644 --- a/Source/DynamicScene/SampledProperty.js +++ b/Source/DynamicScene/SampledProperty.js @@ -416,8 +416,8 @@ define([ * Adds an array of samples * @memberof SampledProperty * - * @param {Array} times An array of JulianDate instances where each index is a sample time. - * @param {Array} values The array of values, where each value corresponds to the provided times index. + * @param {JulianDate[]} times An array of JulianDate instances where each index is a sample time. + * @param {Packable[]} values The array of values, where each value corresponds to the provided times index. * * @exception {DeveloperError} times and values must be the same length.. */ @@ -450,7 +450,7 @@ define([ * Adds samples as a single packed array where each new sample is represented as a date, followed by the packed representation of the corresponding value. * @memberof SampledProperty * - * @param {Array} packedSamples The array of packed samples. + * @param {Number[]} packedSamples The array of packed samples. * @param {JulianDate} [epoch] If any of the dates in packedSamples are numbers, they are considered an offset from this epoch, in seconds. */ SampledProperty.prototype.addSamplesPackedArray = function(packedSamples, epoch) { diff --git a/Source/Renderer/Context.js b/Source/Renderer/Context.js index bd7e9ce3154f..f6bdf5a8ef71 100644 --- a/Source/Renderer/Context.js +++ b/Source/Renderer/Context.js @@ -1074,7 +1074,7 @@ define([ * * @memberof Context * - * @param {Array} [attributes] An optional array of attributes. + * @param {Object[]} [attributes] An optional array of attributes. * @param {IndexBuffer} [indexBuffer] An optional index buffer. * * @returns {VertexArray} The vertex array, ready for use with drawing. diff --git a/Source/Renderer/createShaderSource.js b/Source/Renderer/createShaderSource.js index 7f4f7b175bdb..393bcf18f9f8 100644 --- a/Source/Renderer/createShaderSource.js +++ b/Source/Renderer/createShaderSource.js @@ -24,8 +24,8 @@ define([ * * @exports createShaderSource * - * @param {Array} [options.defines] An array of strings to combine containing GLSL identifiers to #define. - * @param {Array} [options.sources] An array of strings to combine containing GLSL code for the shader. + * @param {String[]} [options.defines] An array of strings to combine containing GLSL identifiers to #define. + * @param {String[]} [options.sources] An array of strings to combine containing GLSL code for the shader. * @param {String} [options.pickColorQualifier] The GLSL qualifier, uniform or varying, for the input czm_pickColor. When defined, a pick fragment shader is generated. * * @returns {String} The generated GLSL shader source. diff --git a/Source/Scene/CullingVolume.js b/Source/Scene/CullingVolume.js index 117117b5262a..c31dd87c32d7 100644 --- a/Source/Scene/CullingVolume.js +++ b/Source/Scene/CullingVolume.js @@ -24,7 +24,7 @@ define([ * Each plane is represented by a 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. - * @type {Array} + * @type {Cartesian4[]} * @default [] */ this.planes = defaultValue(planes, []); diff --git a/Source/Scene/DiscardMissingTileImagePolicy.js b/Source/Scene/DiscardMissingTileImagePolicy.js index f1edf22c9084..15729f16f67b 100644 --- a/Source/Scene/DiscardMissingTileImagePolicy.js +++ b/Source/Scene/DiscardMissingTileImagePolicy.js @@ -23,7 +23,7 @@ define([ * @constructor * * @param {String} options.missingImageUrl The URL of the known missing image. - * @param {Array} options.pixelsToCheck An array of {@link Cartesian2} pixel positions to + * @param {Cartesian2[]} options.pixelsToCheck An array of {@link Cartesian2} pixel positions to * compare against the missing image. * @param {Boolean} [options.disableCheckIfAllPixelsAreTransparent=false] If true, the discard check will be disabled * if all of the pixelsToCheck in the missingImageUrl have an alpha value of 0. If false, the diff --git a/Source/Scene/FrameState.js b/Source/Scene/FrameState.js index 499318a91c70..96d0d124b55c 100644 --- a/Source/Scene/FrameState.js +++ b/Source/Scene/FrameState.js @@ -107,7 +107,7 @@ define([ * directly in update functions. *

* - * @type {Array} + * @type {Function[]} * * @example * frameState.afterRender.push(function() { diff --git a/Source/Scene/ModelAnimationCollection.js b/Source/Scene/ModelAnimationCollection.js index 31f0564fb0eb..d44c9525ef36 100644 --- a/Source/Scene/ModelAnimationCollection.js +++ b/Source/Scene/ModelAnimationCollection.js @@ -183,7 +183,7 @@ define([ * @param {Boolean} [options.reverse=false] When true, the animations are played in reverse. * @param {ModelAnimationLoop} [options.loop=ModelAnimationLoop.NONE] Determines if and how the animations are looped. * - * @returns {Array} An array of {@link ModelAnimation} objects, one for each animation added to the collection. If there are no glTF animations, the array is empty. + * @returns {ModelAnimation[]} An array of {@link ModelAnimation} objects, one for each animation added to the collection. If there are no glTF animations, the array is empty. * * @exception {DeveloperError} Animations are not loaded. Wait for the {@link Model#readyToRender} event. * @exception {DeveloperError} options.speedup must be greater than zero. diff --git a/Source/Scene/ModelMesh.js b/Source/Scene/ModelMesh.js index 5ad15609ad63..043610d54b9e 100644 --- a/Source/Scene/ModelMesh.js +++ b/Source/Scene/ModelMesh.js @@ -71,7 +71,7 @@ define([ * * @memberof ModelMesh.prototype * - * @type {Array} + * @type {ModelMaterial[]} * @readonly */ materials : { diff --git a/Source/Scene/Polygon.js b/Source/Scene/Polygon.js index aedfc296bde5..96f655379216 100644 --- a/Source/Scene/Polygon.js +++ b/Source/Scene/Polygon.js @@ -36,7 +36,7 @@ define([ * @constructor * * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid that the polygon is drawn on. - * @param {Array} [options.positions] The cartesian positions of the polygon. + * @param {Cartesian3[]} [options.positions] The cartesian positions of the polygon. * @param {Object} [options.polygonHierarchy] An object defining the vertex positions of each nested polygon as defined in {@link Polygon#configureFromPolygonHierarchy}. * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude in the underlying geometry. * @param {Number} [options.height=0.0] The height, in meters, that the rectangle is raised above the {@link RectanglePrimitive#ellipsoid}. @@ -209,7 +209,7 @@ define([ /** * Gets and sets positions that define the boundary of the polygon. * @memberof Polygon.prototype - * @type {Array} + * @type {Cartesian3[]} * @example * polygon.positions = [ * ellipsoid.cartographicToCartesian(new Cesium.Cartographic(...)), diff --git a/Source/Scene/Polyline.js b/Source/Scene/Polyline.js index bfb08753f099..77ed919511c1 100644 --- a/Source/Scene/Polyline.js +++ b/Source/Scene/Polyline.js @@ -33,7 +33,7 @@ define([ * @param {Number} [options.width=1.0] The width of the polyline in pixels. * @param {Boolean} [options.loop=false] Whether a line segment will be added between the last and first line positions to make this line a loop. * @param {Material} [options.material=Material.ColorType] The material. - * @param {Array} [options.positions] The positions. + * @param {Cartesian3[]} [options.positions] The positions. * @param {Object} [options.id] The user-defined object to be returned when this polyline is picked. * * @see PolylineCollection @@ -131,7 +131,7 @@ define([ /** * Gets and sets the positions of the polyline. * @memberof Polyline.prototype - * @type {Array} + * @type {Cartesian3[]} * @example * polyline.positions = ellipsoid.cartographicArrayToCartesianArray([ * new Cesium.Cartographic(...), diff --git a/Source/Scene/Scene.js b/Source/Scene/Scene.js index c15983bd7763..605d386fc114 100644 --- a/Source/Scene/Scene.js +++ b/Source/Scene/Scene.js @@ -1445,7 +1445,7 @@ define([ * * @param {Cartesian2} windowPosition Window coordinates to perform picking on. * - * @returns {Array} Array of objects, each containing 1 picked primitives. + * @returns {Object[]} Array of objects, each containing 1 picked primitives. * * @exception {DeveloperError} windowPosition is undefined. * diff --git a/Source/Scene/TextureAtlas.js b/Source/Scene/TextureAtlas.js index 341c5bda5a6d..1f76c3885937 100644 --- a/Source/Scene/TextureAtlas.js +++ b/Source/Scene/TextureAtlas.js @@ -47,7 +47,7 @@ define([ * @param {PixelFormat} [options.pixelFormat=PixelFormat.RGBA] The pixel format of the texture. * @param {Number} [options.borderWidthInPixels=1] The amount of spacing between adjacent images in pixels. * @param {Cartesian2} [options.initialSize=new Cartesian2(16.0, 16.0)] The initial side lengths of the texture. - * @param {Array} [options.images] Optional array of {@link Image} to be added to the atlas. Same as calling addImages(images). + * @param {Image[]} [options.images] Optional array of {@link Image} to be added to the atlas. Same as calling addImages(images). * @param {Image} [options.image] Optional single image to be added to the atlas. Same as calling addImage(image). * * @exception {DeveloperError} borderWidthInPixels must be greater than or equal to zero. @@ -114,7 +114,7 @@ define([ * The x and y values of the rectangle correspond to the bottom-left corner of the texture coordinate. * The coordinates are in the order that the corresponding images were added to the atlas. * @memberof TextureAtlas.prototype - * @type {Array} + * @type {BoundingRectangle[]} */ textureCoordinates : { get : function() { @@ -343,7 +343,7 @@ define([ * * @memberof TextureAtlas * - * @param {Array} images An array of {@link Image} to be added to the texture atlas. + * @param {Image[]} images An array of {@link Image} to be added to the texture atlas. * * @returns {Number} The first index of the newly added images. * @@ -392,7 +392,7 @@ define([ * @memberof TextureAtlas * * @param {Image} image An image to be added to the texture atlas. - * @param {Array} subRegions An array of {@link BoundingRectangle} sub-regions measured in pixels from the bottom-left. + * @param {BoundingRectangle[]} subRegions An array of {@link BoundingRectangle} sub-regions measured in pixels from the bottom-left. * * @returns {Number} The index of the first newly-added region. */ diff --git a/Source/Scene/Tile.js b/Source/Scene/Tile.js index f53c77b5d9df..4369d060092a 100644 --- a/Source/Scene/Tile.js +++ b/Source/Scene/Tile.js @@ -135,7 +135,7 @@ define([ /** * The {@link TileImagery} attached to this tile. - * @type {Array} + * @type {TileImagery[]} * @default [] */ this.imagery = []; @@ -230,7 +230,7 @@ define([ * @memberof Tile * * @param {TilingScheme} tilingScheme The tiling scheme for which the tiles are to be created. - * @returns {Array} An array containing the tiles at level of detail zero, starting with the + * @returns {Tile[]} An array containing the tiles at level of detail zero, starting with the * tile in the northwest corner and followed by the tile (if any) to its east. */ Tile.createLevelZeroTiles = function(tilingScheme) { @@ -262,7 +262,7 @@ define([ /** * An array of tiles that would be at the next level of the tile tree. * @memberof Tile.prototype - * @type {Array} + * @type {Tile[]} */ children : { get : function() { diff --git a/Source/Widgets/BaseLayerPicker/BaseLayerPickerViewModel.js b/Source/Widgets/BaseLayerPicker/BaseLayerPickerViewModel.js index 9fb992ed24a9..a1fc1d00403c 100644 --- a/Source/Widgets/BaseLayerPicker/BaseLayerPickerViewModel.js +++ b/Source/Widgets/BaseLayerPicker/BaseLayerPickerViewModel.js @@ -51,14 +51,14 @@ define([ /** * Gets or sets an array of ProviderViewModel instances available for imagery selection. * This property is observable. - * @type {Array} + * @type {ProviderViewModel[]} */ this.imageryProviderViewModels = imageryProviderViewModels.slice(0); /** * Gets or sets an array of ProviderViewModel instances available for terrain selection. * This property is observable. - * @type {Array} + * @type {ProviderViewModel[]} */ this.terrainProviderViewModels = terrainProviderViewModels.slice(0); diff --git a/Source/Widgets/Viewer/Viewer.js b/Source/Widgets/Viewer/Viewer.js index 95f8089d34a5..2eab48243763 100644 --- a/Source/Widgets/Viewer/Viewer.js +++ b/Source/Widgets/Viewer/Viewer.js @@ -82,9 +82,9 @@ define([ * @param {Boolean} [options.navigationHelpButton=true] If set to the false, the navigation help button will not be created. * @param {Boolean} [options.navigationInstructionsInitiallyVisible=true] True if the navigation instructions should initially be visible, or false if the should not be shown until the user explicitly clicks the button. * @param {ProviderViewModel} [options.selectedImageryProviderViewModel] The view model for the current base imagery layer, if not supplied the first available base layer is used. This value is only valid if options.baseLayerPicker is set to true. - * @param {Array} [options.imageryProviderViewModels=createDefaultImageryProviderViewModels()] The array of ProviderViewModels to be selectable from the BaseLayerPicker. This value is only valid if options.baseLayerPicker is set to true. + * @param {ProviderViewModel[]} [options.imageryProviderViewModels=createDefaultImageryProviderViewModels()] The array of ProviderViewModels to be selectable from the BaseLayerPicker. This value is only valid if options.baseLayerPicker is set to true. * @param {ProviderViewModel} [options.selectedTerrainProviderViewModel] The view model for the current base terrain layer, if not supplied the first available base layer is used. This value is only valid if options.baseLayerPicker is set to true. - * @param {Array} [options.terrainProviderViewModels=createDefaultTerrainProviderViewModels()] The array of ProviderViewModels to be selectable from the BaseLayerPicker. This value is only valid if options.baseLayerPicker is set to true. + * @param {ProviderViewModel[]} [options.terrainProviderViewModels=createDefaultTerrainProviderViewModels()] The array of ProviderViewModels to be selectable from the BaseLayerPicker. This value is only valid if options.baseLayerPicker is set to true. * @param {ImageryProvider} [options.imageryProvider=new BingMapsImageryProvider()] The imagery provider to use. This value is only valid if options.baseLayerPicker is set to false. * @param {TerrainProvider} [options.terrainProvider=new EllipsoidTerrainProvider()] The terrain provider to use * @param {SkyBox} [options.skyBox] The skybox used to render the stars. When undefined, the default stars are used. diff --git a/Source/Workers/cesiumWorkerBootstrapper.js b/Source/Workers/cesiumWorkerBootstrapper.js index 928a60091896..35f2419204f1 100644 --- a/Source/Workers/cesiumWorkerBootstrapper.js +++ b/Source/Workers/cesiumWorkerBootstrapper.js @@ -246,7 +246,7 @@ var requirejs, require, define; * which act like paths, but can be remapped. But the end result, * all paths that use this function should look normalized. * NOTE: this method MODIFIES the input array. - * @param {Array} ary the array of path segments. + * @param {String[]} ary the array of path segments. */ function trimDots(ary) { var i, part;