Skip to content

Commit cb44065

Browse files
shuntershunter
committed
Documentation fixes.
1 parent 469847d commit cb44065

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+92
-140
lines changed

‎Source/Core/AxisAlignedBoundingBox.js

+10-8
Original file line numberDiff line numberDiff line change
@@ -167,10 +167,11 @@ define([
167167
* @param {AxisAlignedBoundingBox} box The bounding box to test.
168168
* @param {Cartesian4} plane The coefficients of the plane in the form <code>ax + by + cz + d = 0</code>
169169
* where the coefficients a, b, c, and d are the components x, y, z, and w
170-
* of the {Cartesian4}, respectively.
171-
* @returns {Intersect} {Intersect.INSIDE} if the entire box is on the side of the plane the normal is pointing,
172-
* {Intersect.OUTSIDE} if the entire box is on the opposite side, and {Intersect.INTERSETING}
173-
* if the box intersects the plane.
170+
* of the {@link Cartesian4}, respectively.
171+
* @returns {Intersect} {@link Intersect.INSIDE} if the entire box is on the side of the plane
172+
* the normal is pointing, {@link Intersect.OUTSIDE} if the entire box is
173+
* on the opposite side, and {@link Intersect.INTERSECTING} if the box
174+
* intersects the plane.
174175
*/
175176
AxisAlignedBoundingBox.intersect = function(box, plane) {
176177
//>>includeStart('debug', pragmas.debug);
@@ -216,10 +217,11 @@ define([
216217
*
217218
* @param {Cartesian4} plane The coefficients of the plane in the form <code>ax + by + cz + d = 0</code>
218219
* where the coefficients a, b, c, and d are the components x, y, z, and w
219-
* of the {Cartesian4}, respectively.
220-
* @returns {Intersect} {Intersect.INSIDE} if the entire box is on the side of the plane the normal is pointing,
221-
* {Intersect.OUTSIDE} if the entire box is on the opposite side, and {Intersect.INTERSETING}
222-
* if the box intersects the plane.
220+
* of the {@link Cartesian4}, respectively.
221+
* @returns {Intersect} {@link Intersect.INSIDE} if the entire box is on the side of the plane
222+
* the normal is pointing, {@link Intersect.OUTSIDE} if the entire box is
223+
* on the opposite side, and {@link Intersect.INTERSECTING} if the box
224+
* intersects the plane.
223225
*/
224226
AxisAlignedBoundingBox.prototype.intersect = function(plane) {
225227
return AxisAlignedBoundingBox.intersect(this, plane);

‎Source/Core/BoundingSphere.js

+11-9
Original file line numberDiff line numberDiff line change
@@ -577,7 +577,7 @@ define([
577577

578578
/**
579579
* The number of elements used to pack the object into an array.
580-
* @Type {Number}
580+
* @type {Number}
581581
*/
582582
BoundingSphere.packedLength = 4;
583583

@@ -717,10 +717,11 @@ define([
717717
* @param {BoundingSphere} sphere The bounding sphere to test.
718718
* @param {Cartesian4} plane The coefficients of the plane in the for ax + by + cz + d = 0
719719
* where the coefficients a, b, c, and d are the components x, y, z,
720-
* and w of the {Cartesian4}, respectively.
721-
* @returns {Intersect} {Intersect.INSIDE} if the entire sphere is on the side of the plane the normal
722-
* is pointing, {Intersect.OUTSIDE} if the entire sphere is on the opposite side,
723-
* and {Intersect.INTERSETING} if the sphere intersects the plane.
720+
* and w of the {@link Cartesian4}, respectively.
721+
* @returns {Intersect} {@link Intersect.INSIDE} if the entire sphere is on the side of the plane
722+
* the normal is pointing, {@link Intersect.OUTSIDE} if the entire sphere is
723+
* on the opposite side, and {@link Intersect.INTERSECTING} if the sphere
724+
* intersects the plane.
724725
*/
725726
BoundingSphere.intersect = function(sphere, plane) {
726727
//>>includeStart('debug', pragmas.debug);
@@ -1022,10 +1023,11 @@ define([
10221023
*
10231024
* @param {Cartesian4} plane The coefficients of the plane in the for ax + by + cz + d = 0
10241025
* where the coefficients a, b, c, and d are the components x, y, z,
1025-
* and w of the {Cartesian4}, respectively.
1026-
* @returns {Intersect} {Intersect.INSIDE} if the entire sphere is on the side of the plane the normal
1027-
* is pointing, {Intersect.OUTSIDE} if the entire sphere is on the opposite side,
1028-
* and {Intersect.INTERSETING} if the sphere intersects the plane.
1026+
* and w of the {@link Cartesian4}, respectively.
1027+
* @returns {Intersect} {@link Intersect.INSIDE} if the entire sphere is on the side of the plane
1028+
* the normal is pointing, {@link Intersect.OUTSIDE} if the entire sphere is
1029+
* on the opposite side, and {@link Intersect.INTERSECTING} if the sphere
1030+
* intersects the plane.
10291031
*/
10301032
BoundingSphere.prototype.intersect = function(plane) {
10311033
return BoundingSphere.intersect(this, plane);

‎Source/Core/Cartesian2.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ define([
105105

106106
/**
107107
* The number of elements used to pack the object into an array.
108-
* @Type {Number}
108+
* @type {Number}
109109
*/
110110
Cartesian2.packedLength = 2;
111111

‎Source/Core/Cartesian3.js

+9-9
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ define([
134134

135135
/**
136136
* The number of elements used to pack the object into an array.
137-
* @Type {Number}
137+
* @type {Number}
138138
*/
139139
Cartesian3.packedLength = 3;
140140

@@ -773,8 +773,8 @@ define([
773773
*
774774
* @param {Number} longitude The longitude, in degrees
775775
* @param {Number} latitude The latitude, in degrees
776-
* @param {Number} [height = 0] The height, in meters, above the ellipsoid.
777-
* @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the position lies.
776+
* @param {Number} [height=0.0] The height, in meters, above the ellipsoid.
777+
* @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the position lies.
778778
* @param {Cartesian3} [result] The object onto which to store the result.
779779
*
780780
* @returns {Cartesian3} The position
@@ -807,8 +807,8 @@ define([
807807
*
808808
* @param {Number} longitude The longitude, in radians
809809
* @param {Number} latitude The latitude, in radians
810-
* @param {Number} [height = 0] The height, in meters, above the ellipsoid.
811-
* @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the position lies.
810+
* @param {Number} [height=0.0] The height, in meters, above the ellipsoid.
811+
* @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the position lies.
812812
* @param {Cartesian3} [result] The object onto which to store the result.
813813
*
814814
* @returns {Cartesian3} The position
@@ -847,7 +847,7 @@ define([
847847
* @memberof Cartesian3
848848
*
849849
* @param {Number[]} coordinates A list of longitude and latitude values. Values alternate [longitude, latitude, longitude, latitude...].
850-
* @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the coordinates lie.
850+
* @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the coordinates lie.
851851
* @param {Cartesian3[]} [result] An array of Cartesian3 objects to store the result.
852852
*
853853
* @returns {Cartesian3[]} The array of positions.
@@ -875,7 +875,7 @@ define([
875875
* @memberof Cartesian3
876876
*
877877
* @param {Number[]} coordinates A list of longitude and latitude values. Values alternate [longitude, latitude, longitude, latitude...].
878-
* @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the coordinates lie.
878+
* @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the coordinates lie.
879879
* @param {Cartesian3[]} [result] An array of Cartesian3 objects to store the result.
880880
*
881881
* @returns {Cartesian3[]} The array of positions.
@@ -917,7 +917,7 @@ define([
917917
* @memberof Cartesian3
918918
*
919919
* @param {Number[]} coordinates A list of longitude, latitude and height values. Values alternate [longitude, latitude, height,, longitude, latitude, height...].
920-
* @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the position lies.
920+
* @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the position lies.
921921
* @param {Cartesian3[]} [result] An array of Cartesian3 objects to store the result.
922922
*
923923
* @returns {Cartesian3[]} The array of positions.
@@ -953,7 +953,7 @@ define([
953953
* @memberof Cartesian3
954954
*
955955
* @param {Number[]} coordinates A list of longitude, latitude and height values. Values alternate [longitude, latitude, height,, longitude, latitude, height...].
956-
* @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the position lies.
956+
* @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the position lies.
957957
* @param {Cartesian3[]} [result] An array of Cartesian3 objects to store the result.
958958
*
959959
* @returns {Cartesian3[]} The array of positions.

‎Source/Core/Cartesian4.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ define([
132132

133133
/**
134134
* The number of elements used to pack the object into an array.
135-
* @Type {Number}
135+
* @type {Number}
136136
*/
137137
Cartesian4.packedLength = 4;
138138

‎Source/Core/CircleOutlineGeometry.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ define([
2323
* @param {Number} [options.height=0.0] The height above the ellipsoid.
2424
* @param {Number} [options.granularity=0.02] The angular distance between points on the circle in radians.
2525
* @param {Number} [options.extrudedHeight=0.0] The height of the extrusion relative to the ellipsoid.
26-
* @param {Number} [options.numberOfVerticalLines = 16] Number of lines to draw between the top and bottom of an extruded circle.
26+
* @param {Number} [options.numberOfVerticalLines=16] Number of lines to draw between the top and bottom of an extruded circle.
2727
*
2828
* @exception {DeveloperError} radius must be greater than zero.
2929
* @exception {DeveloperError} granularity must be greater than zero.

‎Source/Core/ClockRange.js

-3
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ define(function() {
1717
*
1818
* @type {Number}
1919
* @constant
20-
* @default 0
2120
*/
2221
UNBOUNDED : 0,
2322

@@ -27,7 +26,6 @@ define(function() {
2726
*
2827
* @type {Number}
2928
* @constant
30-
* @default 1
3129
*/
3230
CLAMPED : 1,
3331

@@ -39,7 +37,6 @@ define(function() {
3937
*
4038
* @type {Number}
4139
* @constant
42-
* @default 2
4340
*/
4441
LOOP_STOP : 2
4542
};

‎Source/Core/ClockStep.js

-3
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ define(function() {
1818
*
1919
* @type {Number}
2020
* @constant
21-
* @default 0
2221
*/
2322
TICK_DEPENDENT : 0,
2423

@@ -28,7 +27,6 @@ define(function() {
2827
*
2928
* @type {Number}
3029
* @constant
31-
* @default 1
3230
*/
3331
SYSTEM_CLOCK_MULTIPLIER : 1,
3432

@@ -38,7 +36,6 @@ define(function() {
3836
*
3937
* @type {Number}
4038
* @constant
41-
* @default 2
4239
*/
4340
SYSTEM_CLOCK : 2
4441
};

‎Source/Core/Color.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -373,7 +373,7 @@ define([
373373

374374
/**
375375
* The number of elements used to pack the object into an array.
376-
* @Type {Number}
376+
* @type {Number}
377377
*/
378378
Color.packedLength = 4;
379379

‎Source/Core/CornerType.js

-3
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ define(function() {
1414
* Corner is circular.
1515
* @type {Number}
1616
* @constant
17-
* @default 0
1817
*/
1918
ROUNDED : 0,
2019

@@ -26,7 +25,6 @@ define(function() {
2625
* Corner point is the intersection of adjacent edges.
2726
* @type {Number}
2827
* @constant
29-
* @default 1
3028
*/
3129
MITERED : 1,
3230

@@ -38,7 +36,6 @@ define(function() {
3836
* Corner is clipped.
3937
* @type {Number}
4038
* @constant
41-
* @default 2
4239
*/
4340
BEVELED : 2
4441
};

‎Source/Core/CorridorGeometry.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -626,14 +626,14 @@ define([
626626
* @alias CorridorGeometry
627627
* @constructor
628628
*
629-
* @param {Cartesian3[]} options.positions An array of {Cartesain3} positions that define the center of the corridor.
629+
* @param {Cartesian3[]} options.positions An array of positions that define the center of the corridor.
630630
* @param {Number} options.width The distance between the edges of the corridor in meters.
631631
* @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference.
632632
* @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.
633633
* @param {Number} [options.height=0] The distance in meters between the ellipsoid surface and the positions.
634634
* @param {Number} [options.extrudedHeight] The distance in meters between the ellipsoid surface and the extrusion.
635635
* @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed.
636-
* @param {Boolean} [options.cornerType = CornerType.ROUNDED] Determines the style of the corners.
636+
* @param {Boolean} [options.cornerType=CornerType.ROUNDED] Determines the style of the corners.
637637
*
638638
* @see CorridorGeometry.createGeometry
639639
*

‎Source/Core/CorridorOutlineGeometry.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -306,13 +306,13 @@ define([
306306
* @alias CorridorOutlineGeometry
307307
* @constructor
308308
*
309-
* @param {Cartesian3[]} options.positions An array of {Cartesain3} positions that define the center of the corridor outline.
309+
* @param {Cartesian3[]} options.positions An array of positions that define the center of the corridor outline.
310310
* @param {Number} options.width The distance between the edges of the corridor outline.
311311
* @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference.
312312
* @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.
313313
* @param {Number} [options.height=0] The distance between the ellipsoid surface and the positions.
314314
* @param {Number} [options.extrudedHeight] The distance between the ellipsoid surface and the extrusion.
315-
* @param {Boolean} [options.cornerType = CornerType.ROUNDED] Determines the style of the corners.
315+
* @param {Boolean} [options.cornerType=CornerType.ROUNDED] Determines the style of the corners.
316316
*
317317
* @see CorridorOutlineGeometry.createGeometry
318318
*

‎Source/Core/CylinderGeometry.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ define([
4949
* @param {Number} options.length The length of the cylinder.
5050
* @param {Number} options.topRadius The radius of the top of the cylinder.
5151
* @param {Number} options.bottomRadius The radius of the bottom of the cylinder.
52-
* @param {Number} [options.slices = 128] The number of edges around perimeter of the cylinder.
52+
* @param {Number} [options.slices=128] The number of edges around perimeter of the cylinder.
5353
* @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed.
5454
*
5555
* @exception {DeveloperError} options.length must be greater than 0.

‎Source/Core/CylinderOutlineGeometry.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ define([
4040
* @param {Number} options.length The length of the cylinder.
4141
* @param {Number} options.topRadius The radius of the top of the cylinder.
4242
* @param {Number} options.bottomRadius The radius of the bottom of the cylinder.
43-
* @param {Number} [options.slices = 128] The number of edges around perimeter of the cylinder.
44-
* @param {Number} [options.numberOfVerticalLines = 16] Number of lines to draw between the top and bottom surfaces of the cylinder.
43+
* @param {Number} [options.slices=128] The number of edges around perimeter of the cylinder.
44+
* @param {Number} [options.numberOfVerticalLines=16] Number of lines to draw between the top and bottom surfaces of the cylinder.
4545
*
4646
* @exception {DeveloperError} options.length must be greater than 0.
4747
* @exception {DeveloperError} options.topRadius must be greater than 0.

‎Source/Core/EllipseOutlineGeometry.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ define([
147147
* @param {Number} [options.extrudedHeight] The height of the extrusion.
148148
* @param {Number} [options.rotation=0.0] The angle from north (clockwise) in radians. The default is zero.
149149
* @param {Number} [options.granularity=0.02] The angular distance between points on the ellipse in radians.
150-
* @param {Number} [options.numberOfVerticalLines = 16] Number of lines to draw between the top and bottom surface of an extruded ellipse.
150+
* @param {Number} [options.numberOfVerticalLines=16] Number of lines to draw between the top and bottom surface of an extruded ellipse.
151151
*
152152
* @exception {DeveloperError} semiMajorAxis and semiMinorAxis must be greater than zero.
153153
* @exception {DeveloperError} semiMajorAxis must be larger than the semiMajorAxis.

‎Source/Core/Intersect.js

-3
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ define(function() {
1616
*
1717
* @type {Number}
1818
* @constant
19-
* @default -1
2019
*/
2120
OUTSIDE : -1,
2221

@@ -25,7 +24,6 @@ define(function() {
2524
*
2625
* @type {Number}
2726
* @constant
28-
* @default 0
2927
*/
3028
INTERSECTING : 0,
3129

@@ -34,7 +32,6 @@ define(function() {
3432
*
3533
* @type {Number}
3634
* @constant
37-
* @default 1
3835
*/
3936
INSIDE : 1
4037
};

‎Source/Core/JulianDate.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ define([
230230
*
231231
* @param {Number} julianDayNumber The Julian Day Number representing the number of whole days. Fractional days will also be handled correctly.
232232
* @param {Number} julianSecondsOfDay The number of seconds into the current Julian Day Number. Fractional seconds, negative seconds and seconds greater than a day will be handled correctly.
233-
* @param {TimeStandard} [timeStandard = TimeStandard.UTC] The time standard in which the first two parameters are defined.
233+
* @param {TimeStandard} [timeStandard=TimeStandard.UTC] The time standard in which the first two parameters are defined.
234234
*
235235
* @exception {DeveloperError} timeStandard is not a known TimeStandard.
236236
*
@@ -319,7 +319,7 @@ define([
319319
* @memberof JulianDate
320320
*
321321
* @param {Date} date The JavaScript Date object representing the time to be converted to a JulianDate.
322-
* @param {TimeStandard} [timeStandard = TimeStandard.UTC] Indicates the time standard in which this JulianDate is represented.
322+
* @param {TimeStandard} [timeStandard=TimeStandard.UTC] Indicates the time standard in which this JulianDate is represented.
323323
*
324324
* @returns {JulianDate} The new {@Link JulianDate} instance.
325325
*
@@ -621,7 +621,7 @@ define([
621621
* @memberof JulianDate
622622
*
623623
* @param {Number} totalDays The combined Julian Day Number and fractional day.
624-
* @param {TimeStandard} [timeStandard = TimeStandard.UTC] Indicates the time standard in which the first parameter is defined.
624+
* @param {TimeStandard} [timeStandard=TimeStandard.UTC] Indicates the time standard in which the first parameter is defined.
625625
*
626626
* @returns {JulianDate} The new {@Link JulianDate} instance.
627627
*

‎Source/Core/KeyboardEventModifier.js

-3
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ define(function() {
1414
*
1515
* @type {Number}
1616
* @constant
17-
* @default 0
1817
*/
1918
SHIFT : 0,
2019

@@ -23,7 +22,6 @@ define(function() {
2322
*
2423
* @type {Number}
2524
* @constant
26-
* @default 1
2725
*/
2826
CTRL : 1,
2927

@@ -32,7 +30,6 @@ define(function() {
3230
*
3331
* @type {Number}
3432
* @constant
35-
* @default 2
3633
*/
3734
ALT : 2
3835
};

0 commit comments

Comments
 (0)