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 5170184 commit f5df71b
Show file tree
Hide file tree
Showing 16 changed files with 29 additions and 29 deletions.
4 changes: 2 additions & 2 deletions Source/Core/CatmullRomSpline.js
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ define([
*
* @memberof CatmullRomSpline.prototype
*
* @type {Array}
* @type {Number[]}
* @readonly
*/
times : {
Expand All @@ -205,7 +205,7 @@ define([
*
* @memberof CatmullRomSpline.prototype
*
* @type {Array}
* @type {Cartesian3[]}
* @readonly
*/
points : {
Expand Down
8 changes: 4 additions & 4 deletions Source/Core/HermiteSpline.js
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ define([
*
* @memberof HermiteSpline.prototype
*
* @type {Array}
* @type {Number[]}
* @readonly
*/
times : {
Expand All @@ -229,7 +229,7 @@ define([
*
* @memberof HermiteSpline.prototype
*
* @type {Array}
* @type {Cartesian3[]}
* @readonly
*/
points : {
Expand All @@ -243,7 +243,7 @@ define([
*
* @memberof HermiteSpline.prototype
*
* @type {Array}
* @type {Cartesian3[]}
* @readonly
*/
inTangents : {
Expand All @@ -257,7 +257,7 @@ define([
*
* @memberof HermiteSpline.prototype
*
* @type {Array}
* @type {Cartesian3[]}
* @readonly
*/
outTangents : {
Expand Down
2 changes: 1 addition & 1 deletion Source/Core/LeapSecond.js
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ define([
/**
* The list of leap seconds used throughout Cesium.
* @memberof LeapSecond
* @type {Array}
* @type {LeapSecond[]}
*/
leapSeconds: {
get: function() {
Expand Down
4 changes: 2 additions & 2 deletions Source/Core/LinearSpline.js
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ define([
*
* @memberof LinearSpline.prototype
*
* @type {Array}
* @type {Number[]}
* @readonly
*/
times : {
Expand All @@ -93,7 +93,7 @@ define([
*
* @memberof LinearSpline.prototype
*
* @type {Array}
* @type {Cartesian3[]}
* @readonly
*/
points : {
Expand Down
8 changes: 4 additions & 4 deletions Source/Core/PolygonPipeline.js
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ define([
*
* @param {Number} a1i Index of first vertex.
* @param {Number} a2i Index of second vertex.
* @param {Array} pArray Array of <code>{ position, index }</code> objects representing the polygon.
* @param {Object{position: Cartesian2, index: Number}[]} pArray Array of <code>{ position, index }</code> 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
Expand All @@ -367,7 +367,7 @@ define([
*
* @param {Number} a1i Index of first vertex.
* @param {Number} a2i Index of second vertex.
* @param {Array} pArray Array of <code>{ position, index }</code> objects representing the polygon.
* @param {Object{position: Cartesian2, index: Number}[]} pArray Array of <code>{ position, index }</code> objects representing the polygon.
* @returns {Boolean} If true, the cut formed between the two vertices is internal to the angle at vertex 1
*
* @private
Expand Down Expand Up @@ -607,7 +607,7 @@ define([
*
* @param {Cartesian2} a1 Position of first vertex.
* @param {Cartesian2} a2 Position of second vertex.
* @param {Array} pArray Array of <code>{ position, index }</code> objects representing polygon.
* @param {Object{position: Cartesian2, index: Number}[]} pArray Array of <code>{ position, index }</code> objects representing polygon.
* @returns {Boolean} The segment between a1 and a2 intersect another polygon side.
*
* @private
Expand Down Expand Up @@ -703,7 +703,7 @@ 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 <code>{ position, index }</code> objects representing polygon
* @param {Object{position: Cartesian2, index: Number}[]} nodeArray Array of <code>{ position, index }</code> objects representing polygon
* @returns {Number[]} Index array representing triangles that fill the polygon
*
* @exception {DeveloperError} Invalid polygon: must have at least three vertices.
Expand Down
6 changes: 3 additions & 3 deletions Source/Core/QuaternionSpline.js
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ define([
*
* @memberof QuaternionSpline.prototype
*
* @type {Array}
* @type {Number[]}
* @readonly
*/
times : {
Expand All @@ -136,7 +136,7 @@ define([
*
* @memberof QuaternionSpline.prototype
*
* @type {Array}
* @type {Quaternion[]}
* @readonly
*/
points : {
Expand All @@ -150,7 +150,7 @@ define([
*
* @memberof QuaternionSpline.prototype
*
* @type {Array}
* @type {Quaternion[]}
* @readonly
*/
innerQuadrangles : {
Expand Down
4 changes: 2 additions & 2 deletions Source/Core/Spline.js
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion Source/Core/TaskProcessor.js
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion Source/Scene/CullingVolume.js
Original file line number Diff line number Diff line change
Expand Up @@ -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, []);
Expand Down
2 changes: 1 addition & 1 deletion Source/Scene/FrameState.js
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ define([
* directly in <code>update</code> functions.
* </p>
*
* @type {Array}
* @type {Function[]}
*
* @example
* frameState.afterRender.push(function() {
Expand Down
2 changes: 1 addition & 1 deletion Source/Scene/ModelMesh.js
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ define([
*
* @memberof ModelMesh.prototype
*
* @type {Array}
* @type {ModelMaterial[]}
* @readonly
*/
materials : {
Expand Down
2 changes: 1 addition & 1 deletion Source/Scene/Polygon.js
Original file line number Diff line number Diff line change
Expand Up @@ -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(...)),
Expand Down
2 changes: 1 addition & 1 deletion Source/Scene/Polyline.js
Original file line number Diff line number Diff line change
Expand Up @@ -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(...),
Expand Down
2 changes: 1 addition & 1 deletion Source/Scene/TextureAtlas.js
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
Expand Down
4 changes: 2 additions & 2 deletions Source/Scene/Tile.js
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ define([

/**
* The {@link TileImagery} attached to this tile.
* @type {Array}
* @type {TileImagery[]}
* @default []
*/
this.imagery = [];
Expand Down Expand Up @@ -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() {
Expand Down
4 changes: 2 additions & 2 deletions Source/Widgets/BaseLayerPicker/BaseLayerPickerViewModel.js
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down

0 comments on commit f5df71b

Please sign in to comment.