Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor documentation fixes. #1743

Merged
merged 2 commits into from
May 23, 2014
Merged

Minor documentation fixes. #1743

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
469847d
Fix documentation.
shunter May 23, 2014
cb44065
Documentation fixes.
shunter May 23, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions Source/Core/AxisAlignedBoundingBox.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,10 +167,11 @@ define([
* @param {AxisAlignedBoundingBox} box The bounding box to test.
* @param {Cartesian4} plane The coefficients of the plane in the form <code>ax + by + cz + d = 0</code>
* where the coefficients a, b, c, and d are the components x, y, z, and w
* of the {Cartesian4}, respectively.
* @returns {Intersect} {Intersect.INSIDE} if the entire box is on the side of the plane the normal is pointing,
* {Intersect.OUTSIDE} if the entire box is on the opposite side, and {Intersect.INTERSETING}
* if the box intersects the plane.
* of the {@link Cartesian4}, respectively.
* @returns {Intersect} {@link Intersect.INSIDE} if the entire box is on the side of the plane
* the normal is pointing, {@link Intersect.OUTSIDE} if the entire box is
* on the opposite side, and {@link Intersect.INTERSECTING} if the box
* intersects the plane.
*/
AxisAlignedBoundingBox.intersect = function(box, plane) {
//>>includeStart('debug', pragmas.debug);
Expand Down Expand Up @@ -216,10 +217,11 @@ define([
*
* @param {Cartesian4} plane The coefficients of the plane in the form <code>ax + by + cz + d = 0</code>
* where the coefficients a, b, c, and d are the components x, y, z, and w
* of the {Cartesian4}, respectively.
* @returns {Intersect} {Intersect.INSIDE} if the entire box is on the side of the plane the normal is pointing,
* {Intersect.OUTSIDE} if the entire box is on the opposite side, and {Intersect.INTERSETING}
* if the box intersects the plane.
* of the {@link Cartesian4}, respectively.
* @returns {Intersect} {@link Intersect.INSIDE} if the entire box is on the side of the plane
* the normal is pointing, {@link Intersect.OUTSIDE} if the entire box is
* on the opposite side, and {@link Intersect.INTERSECTING} if the box
* intersects the plane.
*/
AxisAlignedBoundingBox.prototype.intersect = function(plane) {
return AxisAlignedBoundingBox.intersect(this, plane);
Expand Down
20 changes: 11 additions & 9 deletions Source/Core/BoundingSphere.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -577,7 +577,7 @@ define([

/**
* The number of elements used to pack the object into an array.
* @Type {Number}
* @type {Number}
*/
BoundingSphere.packedLength = 4;

Expand Down Expand Up @@ -717,10 +717,11 @@ define([
* @param {BoundingSphere} sphere The bounding sphere to test.
* @param {Cartesian4} plane The coefficients of the plane in the for ax + by + cz + d = 0
* where the coefficients a, b, c, and d are the components x, y, z,
* and w of the {Cartesian4}, respectively.
* @returns {Intersect} {Intersect.INSIDE} if the entire sphere is on the side of the plane the normal
* is pointing, {Intersect.OUTSIDE} if the entire sphere is on the opposite side,
* and {Intersect.INTERSETING} if the sphere intersects the plane.
* and w of the {@link Cartesian4}, respectively.
* @returns {Intersect} {@link Intersect.INSIDE} if the entire sphere is on the side of the plane
* the normal is pointing, {@link Intersect.OUTSIDE} if the entire sphere is
* on the opposite side, and {@link Intersect.INTERSECTING} if the sphere
* intersects the plane.
*/
BoundingSphere.intersect = function(sphere, plane) {
//>>includeStart('debug', pragmas.debug);
Expand Down Expand Up @@ -1022,10 +1023,11 @@ define([
*
* @param {Cartesian4} plane The coefficients of the plane in the for ax + by + cz + d = 0
* where the coefficients a, b, c, and d are the components x, y, z,
* and w of the {Cartesian4}, respectively.
* @returns {Intersect} {Intersect.INSIDE} if the entire sphere is on the side of the plane the normal
* is pointing, {Intersect.OUTSIDE} if the entire sphere is on the opposite side,
* and {Intersect.INTERSETING} if the sphere intersects the plane.
* and w of the {@link Cartesian4}, respectively.
* @returns {Intersect} {@link Intersect.INSIDE} if the entire sphere is on the side of the plane
* the normal is pointing, {@link Intersect.OUTSIDE} if the entire sphere is
* on the opposite side, and {@link Intersect.INTERSECTING} if the sphere
* intersects the plane.
*/
BoundingSphere.prototype.intersect = function(plane) {
return BoundingSphere.intersect(this, plane);
Expand Down
12 changes: 6 additions & 6 deletions Source/Core/Cartesian2.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ define([

/**
* The number of elements used to pack the object into an array.
* @Type {Number}
* @type {Number}
*/
Cartesian2.packedLength = 2;

Expand Down Expand Up @@ -184,7 +184,7 @@ define([
* Computes the value of the maximum component for the supplied Cartesian.
* @memberof Cartesian2
*
* @param {Cartesian2} The cartesian to use.
* @param {Cartesian2} cartesian The cartesian to use.
* @returns {Number} The value of the maximum component.
*/
Cartesian2.getMaximumComponent = function(cartesian) {
Expand All @@ -201,7 +201,7 @@ define([
* Computes the value of the minimum component for the supplied Cartesian.
* @memberof Cartesian2
*
* @param {Cartesian2} The cartesian to use.
* @param {Cartesian2} cartesian The cartesian to use.
* @returns {Number} The value of the minimum component.
*/
Cartesian2.getMinimumComponent = function(cartesian) {
Expand Down Expand Up @@ -556,9 +556,9 @@ define([
* Computes the linear interpolation or extrapolation at t using the provided cartesians.
* @memberof Cartesian2
*
* @param start The value corresponding to t at 0.0.
* @param end The value corresponding to t at 1.0.
* @param t The point along t at which to interpolate.
* @param {Cartesian2} start The value corresponding to t at 0.0.
* @param {Cartesian2} end The value corresponding to t at 1.0.
* @param {Number} t The point along t at which to interpolate.
* @param {Cartesian2} [result] The object onto which to store the result.
* @returns {Cartesian2} The modified result parameter or a new Cartesian2 instance if one was not provided.
*/
Expand Down
28 changes: 14 additions & 14 deletions Source/Core/Cartesian3.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ define([

/**
* The number of elements used to pack the object into an array.
* @Type {Number}
* @type {Number}
*/
Cartesian3.packedLength = 3;

Expand Down Expand Up @@ -215,7 +215,7 @@ define([
* Computes the value of the maximum component for the supplied Cartesian.
* @memberof Cartesian3
*
* @param {Cartesian3} The cartesian to use.
* @param {Cartesian3} cartesian The cartesian to use.
* @returns {Number} The value of the maximum component.
*/
Cartesian3.getMaximumComponent = function(cartesian) {
Expand All @@ -232,7 +232,7 @@ define([
* Computes the value of the minimum component for the supplied Cartesian.
* @memberof Cartesian3
*
* @param {Cartesian3} The cartesian to use.
* @param {Cartesian3} cartesian The cartesian to use.
* @returns {Number} The value of the minimum component.
*/
Cartesian3.getMinimumComponent = function(cartesian) {
Expand Down Expand Up @@ -597,9 +597,9 @@ define([
* Computes the linear interpolation or extrapolation at t using the provided cartesians.
* @memberof Cartesian3
*
* @param start The value corresponding to t at 0.0.
* @param end The value corresponding to t at 1.0.
* @param t The point along t at which to interpolate.
* @param {Cartesian3} start The value corresponding to t at 0.0.
* @param {Cartesian3} end The value corresponding to t at 1.0.
* @param {Number} t The point along t at which to interpolate.
* @param {Cartesian3} [result] The object onto which to store the result.
* @returns {Cartesian3} The modified result parameter or a new Cartesian3 instance if one was not provided.
*/
Expand Down Expand Up @@ -773,8 +773,8 @@ define([
*
* @param {Number} longitude The longitude, in degrees
* @param {Number} latitude The latitude, in degrees
* @param {Number} [height = 0] The height, in meters, above the ellipsoid.
* @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the position lies.
* @param {Number} [height=0.0] The height, in meters, above the ellipsoid.
* @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the position lies.
* @param {Cartesian3} [result] The object onto which to store the result.
*
* @returns {Cartesian3} The position
Expand Down Expand Up @@ -807,8 +807,8 @@ define([
*
* @param {Number} longitude The longitude, in radians
* @param {Number} latitude The latitude, in radians
* @param {Number} [height = 0] The height, in meters, above the ellipsoid.
* @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the position lies.
* @param {Number} [height=0.0] The height, in meters, above the ellipsoid.
* @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the position lies.
* @param {Cartesian3} [result] The object onto which to store the result.
*
* @returns {Cartesian3} The position
Expand Down Expand Up @@ -847,7 +847,7 @@ define([
* @memberof Cartesian3
*
* @param {Number[]} coordinates A list of longitude and latitude values. Values alternate [longitude, latitude, longitude, latitude...].
* @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the coordinates lie.
* @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the coordinates lie.
* @param {Cartesian3[]} [result] An array of Cartesian3 objects to store the result.
*
* @returns {Cartesian3[]} The array of positions.
Expand Down Expand Up @@ -875,7 +875,7 @@ define([
* @memberof Cartesian3
*
* @param {Number[]} coordinates A list of longitude and latitude values. Values alternate [longitude, latitude, longitude, latitude...].
* @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the coordinates lie.
* @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the coordinates lie.
* @param {Cartesian3[]} [result] An array of Cartesian3 objects to store the result.
*
* @returns {Cartesian3[]} The array of positions.
Expand Down Expand Up @@ -917,7 +917,7 @@ define([
* @memberof Cartesian3
*
* @param {Number[]} coordinates A list of longitude, latitude and height values. Values alternate [longitude, latitude, height,, longitude, latitude, height...].
* @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the position lies.
* @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the position lies.
* @param {Cartesian3[]} [result] An array of Cartesian3 objects to store the result.
*
* @returns {Cartesian3[]} The array of positions.
Expand Down Expand Up @@ -953,7 +953,7 @@ define([
* @memberof Cartesian3
*
* @param {Number[]} coordinates A list of longitude, latitude and height values. Values alternate [longitude, latitude, height,, longitude, latitude, height...].
* @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the position lies.
* @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the position lies.
* @param {Cartesian3[]} [result] An array of Cartesian3 objects to store the result.
*
* @returns {Cartesian3[]} The array of positions.
Expand Down
12 changes: 6 additions & 6 deletions Source/Core/Cartesian4.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ define([

/**
* The number of elements used to pack the object into an array.
* @Type {Number}
* @type {Number}
*/
Cartesian4.packedLength = 4;

Expand Down Expand Up @@ -217,7 +217,7 @@ define([
* Computes the value of the maximum component for the supplied Cartesian.
* @memberof Cartesian4
*
* @param {Cartesian4} The cartesian to use.
* @param {Cartesian4} cartesian The cartesian to use.
* @returns {Number} The value of the maximum component.
*/
Cartesian4.getMaximumComponent = function(cartesian) {
Expand All @@ -234,7 +234,7 @@ define([
* Computes the value of the minimum component for the supplied Cartesian.
* @memberof Cartesian4
*
* @param {Cartesian4} The cartesian to use.
* @param {Cartesian4} cartesian The cartesian to use.
* @returns {Number} The value of the minimum component.
*/
Cartesian4.getMinimumComponent = function(cartesian) {
Expand Down Expand Up @@ -610,9 +610,9 @@ define([
* Computes the linear interpolation or extrapolation at t using the provided cartesians.
* @memberof Cartesian4
*
* @param start The value corresponding to t at 0.0.
* @param end The value corresponding to t at 1.0.
* @param t The point along t at which to interpolate.
* @param {Cartesian4} start The value corresponding to t at 0.0.
* @param {Cartesian4}end The value corresponding to t at 1.0.
* @param {Number} t The point along t at which to interpolate.
* @param {Cartesian4} [result] The object onto which to store the result.
* @returns {Cartesian4} The modified result parameter or a new Cartesian4 instance if one was not provided.
*/
Expand Down
2 changes: 1 addition & 1 deletion Source/Core/CircleOutlineGeometry.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ define([
* @param {Number} [options.height=0.0] The height above the ellipsoid.
* @param {Number} [options.granularity=0.02] The angular distance between points on the circle in radians.
* @param {Number} [options.extrudedHeight=0.0] The height of the extrusion relative to the ellipsoid.
* @param {Number} [options.numberOfVerticalLines = 16] Number of lines to draw between the top and bottom of an extruded circle.
* @param {Number} [options.numberOfVerticalLines=16] Number of lines to draw between the top and bottom of an extruded circle.
*
* @exception {DeveloperError} radius must be greater than zero.
* @exception {DeveloperError} granularity must be greater than zero.
Expand Down
3 changes: 0 additions & 3 deletions Source/Core/ClockRange.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ define(function() {
*
* @type {Number}
* @constant
* @default 0
*/
UNBOUNDED : 0,

Expand All @@ -27,7 +26,6 @@ define(function() {
*
* @type {Number}
* @constant
* @default 1
*/
CLAMPED : 1,

Expand All @@ -39,7 +37,6 @@ define(function() {
*
* @type {Number}
* @constant
* @default 2
*/
LOOP_STOP : 2
};
Expand Down
3 changes: 0 additions & 3 deletions Source/Core/ClockStep.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ define(function() {
*
* @type {Number}
* @constant
* @default 0
*/
TICK_DEPENDENT : 0,

Expand All @@ -28,7 +27,6 @@ define(function() {
*
* @type {Number}
* @constant
* @default 1
*/
SYSTEM_CLOCK_MULTIPLIER : 1,

Expand All @@ -38,7 +36,6 @@ define(function() {
*
* @type {Number}
* @constant
* @default 2
*/
SYSTEM_CLOCK : 2
};
Expand Down
6 changes: 3 additions & 3 deletions Source/Core/Color.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,7 @@ define([

/**
* The number of elements used to pack the object into an array.
* @Type {Number}
* @type {Number}
*/
Color.packedLength = 4;

Expand Down Expand Up @@ -434,7 +434,7 @@ define([
* @memberof Color
*
* @param {Number} number The number to be converted.
* @returns {number} The converted number.
* @returns {Number} The converted number.
*/
Color.byteToFloat = function(number) {
return number / 255.0;
Expand All @@ -446,7 +446,7 @@ define([
* @memberof Color
*
* @param {Number} number The number to be converted.
* @returns {number} The converted number.
* @returns {Number} The converted number.
*/
Color.floatToByte = function(number) {
return number === 1.0 ? 255.0 : (number * 256.0) | 0;
Expand Down
3 changes: 0 additions & 3 deletions Source/Core/CornerType.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ define(function() {
* Corner is circular.
* @type {Number}
* @constant
* @default 0
*/
ROUNDED : 0,

Expand All @@ -26,7 +25,6 @@ define(function() {
* Corner point is the intersection of adjacent edges.
* @type {Number}
* @constant
* @default 1
*/
MITERED : 1,

Expand All @@ -38,7 +36,6 @@ define(function() {
* Corner is clipped.
* @type {Number}
* @constant
* @default 2
*/
BEVELED : 2
};
Expand Down
4 changes: 2 additions & 2 deletions Source/Core/CorridorGeometry.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -626,14 +626,14 @@ define([
* @alias CorridorGeometry
* @constructor
*
* @param {Cartesian3[]} options.positions An array of {Cartesain3} positions that define the center of the corridor.
* @param {Cartesian3[]} options.positions An array of positions that define the center of the corridor.
* @param {Number} options.width The distance between the edges of the corridor in meters.
* @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference.
* @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer.
* @param {Number} [options.height=0] The distance in meters between the ellipsoid surface and the positions.
* @param {Number} [options.extrudedHeight] The distance in meters between the ellipsoid surface and the extrusion.
* @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed.
* @param {Boolean} [options.cornerType = CornerType.ROUNDED] Determines the style of the corners.
* @param {Boolean} [options.cornerType=CornerType.ROUNDED] Determines the style of the corners.
*
* @see CorridorGeometry.createGeometry
*
Expand Down
4 changes: 2 additions & 2 deletions Source/Core/CorridorOutlineGeometry.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,13 +306,13 @@ define([
* @alias CorridorOutlineGeometry
* @constructor
*
* @param {Cartesian3[]} options.positions An array of {Cartesain3} positions that define the center of the corridor outline.
* @param {Cartesian3[]} options.positions An array of positions that define the center of the corridor outline.
* @param {Number} options.width The distance between the edges of the corridor outline.
* @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference.
* @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer.
* @param {Number} [options.height=0] The distance between the ellipsoid surface and the positions.
* @param {Number} [options.extrudedHeight] The distance between the ellipsoid surface and the extrusion.
* @param {Boolean} [options.cornerType = CornerType.ROUNDED] Determines the style of the corners.
* @param {Boolean} [options.cornerType=CornerType.ROUNDED] Determines the style of the corners.
*
* @see CorridorOutlineGeometry.createGeometry
*
Expand Down
Loading