Skip to content

Commit

Permalink
More jsdoc Array fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
abwood committed May 21, 2014
1 parent 4ece8a6 commit 5170184
Show file tree
Hide file tree
Showing 15 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion Source/Core/CubicRealPolynomial.js
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
2 changes: 1 addition & 1 deletion Source/Core/GeometryPipeline.js
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion Source/Core/IndexDatatype.js
Original file line number Diff line number Diff line change
Expand Up @@ -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 <code>Uint16Array</code> or <code>Uint32Array</code> constructed with <code>indicesLengthOrArray</code>.
* @returns {Uint16Aray|Uint32Array} A <code>Uint16Array</code> or <code>Uint32Array</code> constructed with <code>indicesLengthOrArray</code>.
*
* @example
* this.indices = Cesium.IndexDatatype.createTypedArray(positions.length / 3, numberOfIndices);
Expand Down
2 changes: 1 addition & 1 deletion Source/Core/Matrix2.js
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ define([
*
* @param {Matrix2} matrix The matrix to use..
* @param {Number[]} [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.
* @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);
Expand Down
2 changes: 1 addition & 1 deletion Source/Core/Matrix3.js
Original file line number Diff line number Diff line change
Expand Up @@ -459,7 +459,7 @@ define([
*
* @param {Matrix3} matrix The matrix to use..
* @param {Number[]} [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.
* @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);
Expand Down
2 changes: 1 addition & 1 deletion Source/Core/Matrix4.js
Original file line number Diff line number Diff line change
Expand Up @@ -984,7 +984,7 @@ define([
*
* @param {Matrix4} matrix The matrix to use..
* @param {Number[]} [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.
* @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
Expand Down
4 changes: 2 additions & 2 deletions Source/Core/PolylinePipeline.js
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ define([
*
* @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)]
Expand Down Expand Up @@ -226,7 +226,7 @@ define([
* @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([
Expand Down
2 changes: 1 addition & 1 deletion Source/Core/QuadraticRealPolynomial.js
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
2 changes: 1 addition & 1 deletion Source/Core/QuarticRealPolynomial.js
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
2 changes: 1 addition & 1 deletion Source/Core/Tipsify.js
Original file line number Diff line number Diff line change
Expand Up @@ -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];
Expand Down
2 changes: 1 addition & 1 deletion Source/DynamicScene/CompositeDynamicObjectCollection.js
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down
2 changes: 1 addition & 1 deletion Source/DynamicScene/DynamicObjectCollection.js
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion Source/Scene/ModelAnimationCollection.js
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ define([
* @param {Boolean} [options.reverse=false] When <code>true</code>, 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.
Expand Down
2 changes: 1 addition & 1 deletion Source/Scene/Scene.js
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
Expand Down
2 changes: 1 addition & 1 deletion Source/Scene/Tile.js
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down

0 comments on commit 5170184

Please sign in to comment.