Make sure all nullable Entity API properties are marked as such.

CesiumGS · Jun 3, 2020 · 57ff6d4 · 57ff6d4
1 parent 23bdbbd
commit 57ff6d4
Show file tree

Hide file tree

Showing 14 changed files with 37 additions and 37 deletions.
diff --git a/Source/DataSources/BoxGraphics.js b/Source/DataSources/BoxGraphics.js
@@ -83,7 +83,7 @@ Object.defineProperties(BoxGraphics.prototype, {
   /**
    * Gets or sets {@link Cartesian3} Property property specifying the length, width, and height of the box.
    * @memberof BoxGraphics.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    */
   dimensions: createPropertyDescriptor("dimensions"),
 

diff --git a/Source/DataSources/CheckerboardMaterialProperty.js b/Source/DataSources/CheckerboardMaterialProperty.js
@@ -73,23 +73,23 @@ Object.defineProperties(CheckerboardMaterialProperty.prototype, {
   /**
    * Gets or sets the Property specifying the first {@link Color}.
    * @memberof CheckerboardMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default Color.WHITE
    */
   evenColor: createPropertyDescriptor("evenColor"),
 
   /**
    * Gets or sets the Property specifying the second {@link Color}.
    * @memberof CheckerboardMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default Color.BLACK
    */
   oddColor: createPropertyDescriptor("oddColor"),
 
   /**
    * Gets or sets the {@link Cartesian2} Property specifying how many times the tiles repeat in each direction.
    * @memberof CheckerboardMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default new Cartesian2(2.0, 2.0)
    */
   repeat: createPropertyDescriptor("repeat"),

diff --git a/Source/DataSources/ColorMaterialProperty.js b/Source/DataSources/ColorMaterialProperty.js
@@ -53,7 +53,7 @@ Object.defineProperties(ColorMaterialProperty.prototype, {
   /**
    * Gets or sets the {@link Color} {@link Property}.
    * @memberof ColorMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default Color.WHITE
    */
   color: createPropertyDescriptor("color"),

diff --git a/Source/DataSources/GridMaterialProperty.js b/Source/DataSources/GridMaterialProperty.js
@@ -86,39 +86,39 @@ Object.defineProperties(GridMaterialProperty.prototype, {
   /**
    * Gets or sets the Property specifying the grid {@link Color}.
    * @memberof GridMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default Color.WHITE
    */
   color: createPropertyDescriptor("color"),
 
   /**
    * Gets or sets the numeric Property specifying cell alpha values.
    * @memberof GridMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default 0.1
    */
   cellAlpha: createPropertyDescriptor("cellAlpha"),
 
   /**
    * Gets or sets the {@link Cartesian2} Property specifying the number of grid lines along each axis.
    * @memberof GridMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default new Cartesian2(8.0, 8.0)
    */
   lineCount: createPropertyDescriptor("lineCount"),
 
   /**
    * Gets or sets the {@link Cartesian2} Property specifying the thickness of grid lines along each axis.
    * @memberof GridMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default new Cartesian2(1.0, 1.0)
    */
   lineThickness: createPropertyDescriptor("lineThickness"),
 
   /**
    * Gets or sets the {@link Cartesian2} Property specifying the starting offset of grid lines along each axis.
    * @memberof GridMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default new Cartesian2(0.0, 0.0)
    */
   lineOffset: createPropertyDescriptor("lineOffset"),

diff --git a/Source/DataSources/ImageMaterialProperty.js b/Source/DataSources/ImageMaterialProperty.js
@@ -75,30 +75,30 @@ Object.defineProperties(ImageMaterialProperty.prototype, {
   /**
    * Gets or sets the Property specifying Image, URL, Canvas, or Video to use.
    * @memberof ImageMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    */
   image: createPropertyDescriptor("image"),
 
   /**
    * Gets or sets the {@link Cartesian2} Property specifying the number of times the image repeats in each direction.
    * @memberof ImageMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default new Cartesian2(1, 1)
    */
   repeat: createPropertyDescriptor("repeat"),
 
   /**
    * Gets or sets the Color Property specifying the desired color applied to the image.
    * @memberof ImageMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default 1.0
    */
   color: createPropertyDescriptor("color"),
 
   /**
    * Gets or sets the Boolean Property specifying whether the image has transparency
    * @memberof ImageMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default 1.0
    */
   transparent: createPropertyDescriptor("transparent"),

diff --git a/Source/DataSources/NodeTransformationProperty.js b/Source/DataSources/NodeTransformationProperty.js
@@ -70,23 +70,23 @@ Object.defineProperties(NodeTransformationProperty.prototype, {
   /**
    * Gets or sets the {@link Cartesian3} Property specifying the (x, y, z) translation to apply to the node.
    * @memberof NodeTransformationProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default Cartesian3.ZERO
    */
   translation: createPropertyDescriptor("translation"),
 
   /**
    * Gets or sets the {@link Quaternion} Property specifying the (x, y, z, w) rotation to apply to the node.
    * @memberof NodeTransformationProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default Quaternion.IDENTITY
    */
   rotation: createPropertyDescriptor("rotation"),
 
   /**
    * Gets or sets the {@link Cartesian3} Property specifying the (x, y, z) scaling to apply to the node.
    * @memberof NodeTransformationProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default new Cartesian3(1.0, 1.0, 1.0)
    */
   scale: createPropertyDescriptor("scale"),

diff --git a/Source/DataSources/PolylineArrowMaterialProperty.js b/Source/DataSources/PolylineArrowMaterialProperty.js
@@ -51,7 +51,7 @@ Object.defineProperties(PolylineArrowMaterialProperty.prototype, {
   /**
    * Gets or sets the {@link Color} {@link Property}.
    * @memberof PolylineArrowMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default Color.WHITE
    */
   color: createPropertyDescriptor("color"),

diff --git a/Source/DataSources/PolylineDashMaterialProperty.js b/Source/DataSources/PolylineDashMaterialProperty.js
@@ -74,28 +74,28 @@ Object.defineProperties(PolylineDashMaterialProperty.prototype, {
   /**
    * Gets or sets the Property specifying the {@link Color} of the line.
    * @memberof PolylineDashMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    */
   color: createPropertyDescriptor("color"),
 
   /**
    * Gets or sets the Property specifying the {@link Color} of the gaps in the line.
    * @memberof PolylineDashMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    */
   gapColor: createPropertyDescriptor("gapColor"),
 
   /**
    * Gets or sets the numeric Property specifying the length of a dash cycle
    * @memberof PolylineDashMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    */
   dashLength: createPropertyDescriptor("dashLength"),
 
   /**
    * Gets or sets the numeric Property specifying a dash pattern
    * @memberof PolylineDashMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    */
   dashPattern: createPropertyDescriptor("dashPattern"),
 });

diff --git a/Source/DataSources/PolylineGlowMaterialProperty.js b/Source/DataSources/PolylineGlowMaterialProperty.js
@@ -66,21 +66,21 @@ Object.defineProperties(PolylineGlowMaterialProperty.prototype, {
   /**
    * Gets or sets the Property specifying the {@link Color} of the line.
    * @memberof PolylineGlowMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    */
   color: createPropertyDescriptor("color"),
 
   /**
    * Gets or sets the numeric Property specifying the strength of the glow, as a percentage of the total line width (less than 1.0).
    * @memberof PolylineGlowMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    */
   glowPower: createPropertyDescriptor("glowPower"),
 
   /**
    * Gets or sets the numeric Property specifying the strength of the tapering effect, as a percentage of the total line length.  If 1.0 or higher, no taper effect is used.
    * @memberof PolylineGlowMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    */
   taperPower: createPropertyDescriptor("taperPower"),
 });

diff --git a/Source/DataSources/PolylineOutlineMaterialProperty.js b/Source/DataSources/PolylineOutlineMaterialProperty.js
@@ -70,23 +70,23 @@ Object.defineProperties(PolylineOutlineMaterialProperty.prototype, {
   /**
    * Gets or sets the Property specifying the {@link Color} of the line.
    * @memberof PolylineOutlineMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default Color.WHITE
    */
   color: createPropertyDescriptor("color"),
 
   /**
    * Gets or sets the Property specifying the {@link Color} of the outline.
    * @memberof PolylineOutlineMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default Color.BLACK
    */
   outlineColor: createPropertyDescriptor("outlineColor"),
 
   /**
    * Gets or sets the numeric Property specifying the width of the outline.
    * @memberof PolylineOutlineMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default 1.0
    */
   outlineWidth: createPropertyDescriptor("outlineWidth"),

diff --git a/Source/DataSources/ReferenceProperty.js b/Source/DataSources/ReferenceProperty.js
@@ -191,7 +191,7 @@ Object.defineProperties(ReferenceProperty.prototype, {
   /**
    * Gets the resolved instance of the underlying referenced property.
    * @memberof ReferenceProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @readonly
    */
   resolvedProperty: {

diff --git a/Source/DataSources/StripeMaterialProperty.js b/Source/DataSources/StripeMaterialProperty.js
@@ -84,23 +84,23 @@ Object.defineProperties(StripeMaterialProperty.prototype, {
   /**
    * Gets or sets the Property specifying the {@link StripeOrientation}/
    * @memberof StripeMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default StripeOrientation.HORIZONTAL
    */
   orientation: createPropertyDescriptor("orientation"),
 
   /**
    * Gets or sets the Property specifying the first {@link Color}.
    * @memberof StripeMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default Color.WHITE
    */
   evenColor: createPropertyDescriptor("evenColor"),
 
   /**
    * Gets or sets the Property specifying the second {@link Color}.
    * @memberof StripeMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default Color.BLACK
    */
   oddColor: createPropertyDescriptor("oddColor"),
@@ -111,15 +111,15 @@ Object.defineProperties(StripeMaterialProperty.prototype, {
    * of the odd color, 2.0 being the even color again, and any multiple or fractional values
    * being in between.
    * @memberof StripeMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default 0.0
    */
   offset: createPropertyDescriptor("offset"),
 
   /**
    * Gets or sets the numeric Property specifying how many times the stripes repeat.
    * @memberof StripeMaterialProperty.prototype
-   * @type {Property}
+   * @type {Property|undefined}
    * @default 1.0
    */
   repeat: createPropertyDescriptor("repeat"),

diff --git a/Source/DataSources/VelocityOrientationProperty.js b/Source/DataSources/VelocityOrientationProperty.js
@@ -71,7 +71,7 @@ Object.defineProperties(VelocityOrientationProperty.prototype, {
    * Gets or sets the position property used to compute orientation.
    * @memberof VelocityOrientationProperty.prototype
    *
-   * @type {Property}
+   * @type {Property|undefined}
    */
   position: {
     get: function () {
@@ -85,7 +85,7 @@ Object.defineProperties(VelocityOrientationProperty.prototype, {
    * Gets or sets the ellipsoid used to determine which way is up.
    * @memberof VelocityOrientationProperty.prototype
    *
-   * @type {Property}
+   * @type {Property|undefined}
    */
   ellipsoid: {
     get: function () {

diff --git a/Source/DataSources/VelocityVectorProperty.js b/Source/DataSources/VelocityVectorProperty.js
@@ -66,7 +66,7 @@ Object.defineProperties(VelocityVectorProperty.prototype, {
    * Gets or sets the position property used to compute the velocity vector.
    * @memberof VelocityVectorProperty.prototype
    *
-   * @type {Property}
+   * @type {Property|undefined}
    */
   position: {
     get: function () {