diff --git a/Source/Core/ArcGisImageServerTerrainProvider.js b/Source/Core/ArcGisImageServerTerrainProvider.js index e816f66a6173..bc68e2c56433 100644 --- a/Source/Core/ArcGisImageServerTerrainProvider.js +++ b/Source/Core/ArcGisImageServerTerrainProvider.js @@ -40,6 +40,7 @@ define([ * @alias ArcGisImageServerTerrainProvider * @constructor * + * @param {Object} options Object with the following properties: * @param {String} options.url The URL of the ArcGIS ImageServer service. * @param {String} [options.token] The authorization token to use to connect to the service. * @param {Object} [options.proxy] A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL, if needed. diff --git a/Source/Core/BoxGeometry.js b/Source/Core/BoxGeometry.js index 7f6dae6d15f3..ecebed8cea82 100644 --- a/Source/Core/BoxGeometry.js +++ b/Source/Core/BoxGeometry.js @@ -33,6 +33,7 @@ define([ * @alias BoxGeometry * @constructor * + * @param {Object} options Object with the following properties: * @param {Cartesian3} options.minimumCorner The minimum x, y, and z coordinates of the box. * @param {Cartesian3} options.maximumCorner The maximum x, y, and z coordinates of the box. * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. diff --git a/Source/Core/CatmullRomSpline.js b/Source/Core/CatmullRomSpline.js index e2eae16701e5..77ac539462e9 100644 --- a/Source/Core/CatmullRomSpline.js +++ b/Source/Core/CatmullRomSpline.js @@ -104,6 +104,7 @@ define([ * @alias CatmullRomSpline * @constructor * + * @param {Object} options Object with the following properties: * @param {Number[]} options.times An array of strictly increasing, unit-less, floating-point times at each point. * The values are in no way connected to the clock time. They are the parameterization for the curve. * @param {Cartesian3[]} options.points The array of {@link Cartesian3} control points. diff --git a/Source/Core/CesiumTerrainProvider.js b/Source/Core/CesiumTerrainProvider.js index 99942dbd2b03..5774f79e183b 100644 --- a/Source/Core/CesiumTerrainProvider.js +++ b/Source/Core/CesiumTerrainProvider.js @@ -49,6 +49,7 @@ define([ * @alias CesiumTerrainProvider * @constructor * + * @param {Object} options Object with the following properties: * @param {String} options.url The URL of the Cesium terrain server. * @param {Proxy} [options.proxy] A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL, if needed. * @param {Credit|String} [options.credit] A credit for the data source, which is displayed on the canvas. diff --git a/Source/Core/CircleGeometry.js b/Source/Core/CircleGeometry.js index 33a7eed8e660..3efe9390deb6 100644 --- a/Source/Core/CircleGeometry.js +++ b/Source/Core/CircleGeometry.js @@ -17,6 +17,7 @@ define([ * @alias CircleGeometry * @constructor * + * @param {Object} options Object with the following properties: * @param {Cartesian3} options.center The circle's center point in the fixed frame. * @param {Number} options.radius The radius in meters. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid the circle will be on. diff --git a/Source/Core/CircleOutlineGeometry.js b/Source/Core/CircleOutlineGeometry.js index 95f3a00c4d67..76e28562d766 100644 --- a/Source/Core/CircleOutlineGeometry.js +++ b/Source/Core/CircleOutlineGeometry.js @@ -17,6 +17,7 @@ define([ * @alias CircleOutlineGeometry * @constructor * + * @param {Object} options Object with the following properties: * @param {Cartesian3} options.center The circle's center point in the fixed frame. * @param {Number} options.radius The radius in meters. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid the circle will be on. diff --git a/Source/Core/Clock.js b/Source/Core/Clock.js index e792253af93d..cf35a8abc9de 100644 --- a/Source/Core/Clock.js +++ b/Source/Core/Clock.js @@ -25,6 +25,7 @@ define([ * @alias Clock * @constructor * + * @param {Object} options Object with the following properties: * @param {JulianDate} [options.startTime] The start time of the clock. * @param {JulianDate} [options.stopTime] The stop time of the clock. * @param {JulianDate} [options.currentTime] The current time. diff --git a/Source/Core/Color.js b/Source/Core/Color.js index 8a74594ff34d..c8fd00f85660 100644 --- a/Source/Core/Color.js +++ b/Source/Core/Color.js @@ -193,7 +193,7 @@ define([ * call {@link CesiumMath#setRandomNumberSeed} once at the beginning of your application. * @memberof Color * - * @param {Object} [options] Object containing the options. + * @param {Object} [options] Object with the following properties: * @param {Number} [options.red] If specified, the red component to use instead of a randomized value. * @param {Number} [options.minimumRed=0.0] The maximum red value to generate if none was specified. * @param {Number} [options.maximumRed=1.0] The minimum red value to generate if none was specified. diff --git a/Source/Core/CorridorGeometry.js b/Source/Core/CorridorGeometry.js index 6f976942cad4..38218ed5bdff 100644 --- a/Source/Core/CorridorGeometry.js +++ b/Source/Core/CorridorGeometry.js @@ -626,6 +626,7 @@ define([ * @alias CorridorGeometry * @constructor * + * @param {Object} options Object with the following properties: * @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. diff --git a/Source/Core/CorridorOutlineGeometry.js b/Source/Core/CorridorOutlineGeometry.js index 3e55920c673f..12cf0bb76bdc 100644 --- a/Source/Core/CorridorOutlineGeometry.js +++ b/Source/Core/CorridorOutlineGeometry.js @@ -306,6 +306,7 @@ define([ * @alias CorridorOutlineGeometry * @constructor * + * @param {Object} options Object with the following properties: * @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. diff --git a/Source/Core/CylinderGeometry.js b/Source/Core/CylinderGeometry.js index c557224e56d6..23a74cdc3667 100644 --- a/Source/Core/CylinderGeometry.js +++ b/Source/Core/CylinderGeometry.js @@ -46,6 +46,7 @@ define([ * @alias CylinderGeometry * @constructor * + * @param {Object} options Object with the following properties: * @param {Number} options.length The length of the cylinder. * @param {Number} options.topRadius The radius of the top of the cylinder. * @param {Number} options.bottomRadius The radius of the bottom of the cylinder. diff --git a/Source/Core/CylinderOutlineGeometry.js b/Source/Core/CylinderOutlineGeometry.js index f5cae1fd01a5..992a2ccc5380 100644 --- a/Source/Core/CylinderOutlineGeometry.js +++ b/Source/Core/CylinderOutlineGeometry.js @@ -37,6 +37,7 @@ define([ * @alias CylinderOutlineGeometry * @constructor * + * @param {Object} options Object with the following properties: * @param {Number} options.length The length of the cylinder. * @param {Number} options.topRadius The radius of the top of the cylinder. * @param {Number} options.bottomRadius The radius of the bottom of the cylinder. diff --git a/Source/Core/EarthOrientationParameters.js b/Source/Core/EarthOrientationParameters.js index 86a039d82991..3025bacf149f 100644 --- a/Source/Core/EarthOrientationParameters.js +++ b/Source/Core/EarthOrientationParameters.js @@ -36,6 +36,7 @@ define([ * @alias EarthOrientationParameters * @constructor * + * @param {Object} [options] Object with the following properties: * @param {String} [options.url] The URL from which to obtain EOP data. If neither this * parameter nor options.data is specified, all EOP values are assumed * to be 0.0. If options.data is specified, this parameter is diff --git a/Source/Core/EllipseGeometry.js b/Source/Core/EllipseGeometry.js index 02ef22ba39a0..0d765415773c 100644 --- a/Source/Core/EllipseGeometry.js +++ b/Source/Core/EllipseGeometry.js @@ -571,6 +571,7 @@ define([ * @alias EllipseGeometry * @constructor * + * @param {Object} options Object with the following properties: * @param {Cartesian3} options.center The ellipse's center point in the fixed frame. * @param {Number} options.semiMajorAxis The length of the ellipse's semi-major axis in meters. * @param {Number} options.semiMinorAxis The length of the ellipse's semi-minor axis in meters. diff --git a/Source/Core/EllipseOutlineGeometry.js b/Source/Core/EllipseOutlineGeometry.js index 46e088b5c479..c5406dc6de89 100644 --- a/Source/Core/EllipseOutlineGeometry.js +++ b/Source/Core/EllipseOutlineGeometry.js @@ -139,6 +139,7 @@ define([ * @alias EllipseOutlineGeometry * @constructor * + * @param {Object} options Object with the following properties: * @param {Cartesian3} options.center The ellipse's center point in the fixed frame. * @param {Number} options.semiMajorAxis The length of the ellipse's semi-major axis in meters. * @param {Number} options.semiMinorAxis The length of the ellipse's semi-minor axis in meters. diff --git a/Source/Core/EllipsoidGeometry.js b/Source/Core/EllipsoidGeometry.js index 01b0fc90d346..d4118860047f 100644 --- a/Source/Core/EllipsoidGeometry.js +++ b/Source/Core/EllipsoidGeometry.js @@ -47,6 +47,7 @@ define([ * @alias EllipsoidGeometry * @constructor * + * @param {Object} [options] Object with the following properties: * @param {Cartesian3} [options.radii=Cartesian3(1.0, 1.0, 1.0)] The radii of the ellipsoid in the x, y, and z directions. * @param {Number} [options.stackPartitions=64] The number of times to partition the ellipsoid into stacks. * @param {Number} [options.slicePartitions=64] The number of times to partition the ellipsoid into radial slices. diff --git a/Source/Core/EllipsoidOutlineGeometry.js b/Source/Core/EllipsoidOutlineGeometry.js index 77fa4ae38d59..94e00ac103f9 100644 --- a/Source/Core/EllipsoidOutlineGeometry.js +++ b/Source/Core/EllipsoidOutlineGeometry.js @@ -37,6 +37,7 @@ define([ * @alias EllipsoidOutlineGeometry * @constructor * + * @param {Object} [options] Object with the following properties: * @param {Cartesian3} [options.radii=Cartesian3(1.0, 1.0, 1.0)] The radii of the ellipsoid in the x, y, and z directions. * @param {Number} [options.stackPartitions=10] The count of stacks for the ellipsoid (1 greater than the number of parallel lines). * @param {Number} [options.slicePartitions=8] The count of slices for the ellipsoid (Equal to the number of radial lines). diff --git a/Source/Core/EllipsoidTerrainProvider.js b/Source/Core/EllipsoidTerrainProvider.js index 7744bea5324a..6acf485e3ac5 100644 --- a/Source/Core/EllipsoidTerrainProvider.js +++ b/Source/Core/EllipsoidTerrainProvider.js @@ -26,6 +26,7 @@ define([ * @alias EllipsoidTerrainProvider * @constructor * + * @param {Object} [options] Object with the following properties: * @param {TilingScheme} [options.tilingScheme] The tiling scheme specifying how the ellipsoidal * surface is broken into tiles. If this parameter is not provided, a {@link GeographicTilingScheme} * is used. diff --git a/Source/Core/GeographicTilingScheme.js b/Source/Core/GeographicTilingScheme.js index 912a98af7c7e..36d8345b2d48 100644 --- a/Source/Core/GeographicTilingScheme.js +++ b/Source/Core/GeographicTilingScheme.js @@ -31,6 +31,7 @@ define([ * @alias GeographicTilingScheme * @constructor * + * @param {Object} [options] Object with the following properties: * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid whose surface is being tiled. Defaults to * the WGS84 ellipsoid. * @param {Rectangle} [options.rectangle=Rectangle.MAX_VALUE] The rectangle, in radians, covered by the tiling scheme. diff --git a/Source/Core/Geometry.js b/Source/Core/Geometry.js index 5aacb82f6650..959ffb7a9272 100644 --- a/Source/Core/Geometry.js +++ b/Source/Core/Geometry.js @@ -21,6 +21,7 @@ define([ * @alias Geometry * @constructor * + * @param {Object} options Object with the following properties: * @param {GeometryAttributes} options.attributes Attributes, which make up the geometry's vertices. * @param {PrimitiveType} options.primitiveType The type of primitives in the geometry. * @param {Uint16Array|Uint32Array} [options.indices] Optional index data that determines the primitives in the geometry. diff --git a/Source/Core/GeometryAttribute.js b/Source/Core/GeometryAttribute.js index 2554081f7eb3..9335b8f25867 100644 --- a/Source/Core/GeometryAttribute.js +++ b/Source/Core/GeometryAttribute.js @@ -17,6 +17,7 @@ define([ * @alias GeometryAttribute * @constructor * + * @param {Object} [options] Object with the following properties: * @param {ComponentDatatype} [options.componentDatatype] The datatype of each component in the attribute, e.g., individual elements in values. * @param {Number} [options.componentsPerAttribute] A number between 1 and 4 that defines the number of components in an attributes. * @param {Boolean} [options.normalize=false] When true and componentDatatype is an integer format, indicate that the components should be mapped to the range [0, 1] (unsigned) or [-1, 1] (signed) when they are accessed as floating-point for rendering. diff --git a/Source/Core/GeometryInstance.js b/Source/Core/GeometryInstance.js index 5f6f2d63bad3..dd549b488feb 100644 --- a/Source/Core/GeometryInstance.js +++ b/Source/Core/GeometryInstance.js @@ -20,6 +20,7 @@ define([ * @alias GeometryInstance * @constructor * + * @param {Object} options Object with the following properties: * @param {Geometry} options.geometry The geometry to instance. * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The model matrix that transforms to transform the geometry from model to world coordinates. * @param {Object} [options.id] A user-defined object to return when the instance is picked with {@link Scene#pick} or get/set per-instance attributes with {@link Primitive#getGeometryInstanceAttributes}. diff --git a/Source/Core/GeometryInstanceAttribute.js b/Source/Core/GeometryInstanceAttribute.js index 287b13824cd2..a5338cb67585 100644 --- a/Source/Core/GeometryInstanceAttribute.js +++ b/Source/Core/GeometryInstanceAttribute.js @@ -15,6 +15,7 @@ define([ * @alias GeometryInstanceAttribute * @constructor * + * @param {Object} options Object with the following properties: * @param {ComponentDatatype} [options.componentDatatype] The datatype of each component in the attribute, e.g., individual elements in values. * @param {Number} [options.componentsPerAttribute] A number between 1 and 4 that defines the number of components in an attributes. * @param {Boolean} [options.normalize=false] When true and componentDatatype is an integer format, indicate that the components should be mapped to the range [0, 1] (unsigned) or [-1, 1] (signed) when they are accessed as floating-point for rendering. diff --git a/Source/Core/HeightmapTerrainData.js b/Source/Core/HeightmapTerrainData.js index 411ff4b7b9bb..3d4f0d7e976c 100644 --- a/Source/Core/HeightmapTerrainData.js +++ b/Source/Core/HeightmapTerrainData.js @@ -34,6 +34,7 @@ define([ * @alias HeightmapTerrainData * @constructor * + * @param {Object} options Object with the following properties: * @param {TypedArray} options.buffer The buffer containing height data. * @param {Number} options.width The width (longitude direction) of the heightmap, in samples. * @param {Number} options.height The height (latitude direction) of the heightmap, in samples. diff --git a/Source/Core/HeightmapTessellator.js b/Source/Core/HeightmapTessellator.js index f4736953cf79..7d1e60be5f98 100644 --- a/Source/Core/HeightmapTessellator.js +++ b/Source/Core/HeightmapTessellator.js @@ -45,6 +45,7 @@ define([ * * @memberof HeightmapTessellator * + * @param {Object} options Object with the following properties: * @param {Array|Float32Array} options.vertices The array to use to store computed vertices. * If options.skirtHeight is 0.0, the array should have * options.width * options.height * 6 elements. If diff --git a/Source/Core/HermiteSpline.js b/Source/Core/HermiteSpline.js index 331207ed6a7c..67660b998f44 100644 --- a/Source/Core/HermiteSpline.js +++ b/Source/Core/HermiteSpline.js @@ -134,6 +134,7 @@ define([ * @alias HermiteSpline * @constructor * + * @param {Object} options Object with the following properties: * @param {Number[]} options.times An array of strictly increasing, unit-less, floating-point times at each point. * The values are in no way connected to the clock time. They are the parameterization for the curve. * @param {Cartesian3[]} options.points The array of {@link Cartesian3} control points. diff --git a/Source/Core/Iau2006XysData.js b/Source/Core/Iau2006XysData.js index c3d241e1cab4..137b2e82fafa 100644 --- a/Source/Core/Iau2006XysData.js +++ b/Source/Core/Iau2006XysData.js @@ -26,6 +26,7 @@ define([ * @alias Iau2006XysData * @constructor * + * @param {Object} [options] Object with the following properties: * @param {String} [options.xysFileUrlTemplate='Assets/IAU2006_XYS/IAU2006_XYS_{0}.json'] A template URL for obtaining the XYS data. In the template, * `{0}` will be replaced with the file index. * @param {Number} [options.interpolationOrder=9] The order of interpolation to perform on the XYS data. diff --git a/Source/Core/PolygonGeometry.js b/Source/Core/PolygonGeometry.js index 0fc5d4478e48..97853a661033 100644 --- a/Source/Core/PolygonGeometry.js +++ b/Source/Core/PolygonGeometry.js @@ -475,6 +475,7 @@ define([ * @alias PolygonGeometry * @constructor * + * @param {Object} options Object with the following properties: * @param {Object} options.polygonHierarchy A polygon hierarchy that can include holes. * @param {Number} [options.height=0.0] The height of the polygon. * @param {Number} [options.extrudedHeight] The height of the polygon. diff --git a/Source/Core/PolygonOutlineGeometry.js b/Source/Core/PolygonOutlineGeometry.js index 6abfe89495c4..b1db10acfe1d 100644 --- a/Source/Core/PolygonOutlineGeometry.js +++ b/Source/Core/PolygonOutlineGeometry.js @@ -193,6 +193,7 @@ define([ * @alias PolygonOutlineGeometry * @constructor * + * @param {Object} options Object with the following properties: * @param {Object} options.polygonHierarchy A polygon hierarchy that can include holes. * @param {Number} [options.height=0.0] The height of the polygon. * @param {Number} [options.extrudedHeight] The height of the polygon. diff --git a/Source/Core/PolylineGeometry.js b/Source/Core/PolylineGeometry.js index ca99f6783a5f..a61c1f17dd61 100644 --- a/Source/Core/PolylineGeometry.js +++ b/Source/Core/PolylineGeometry.js @@ -39,6 +39,7 @@ define([ * @alias PolylineGeometry * @constructor * + * @param {Object} options Object with the following properties: * @param {Cartesian3[]} options.positions An array of {@link Cartesian3} defining the positions in the polyline as a line strip. * @param {Number} [options.width=1.0] The width in pixels. * @param {Color[]} [options.colors] An Array of {@link Color} defining the per vertex or per segment colors. diff --git a/Source/Core/PolylineVolumeGeometry.js b/Source/Core/PolylineVolumeGeometry.js index cdf34399d919..7f9432898402 100644 --- a/Source/Core/PolylineVolumeGeometry.js +++ b/Source/Core/PolylineVolumeGeometry.js @@ -178,6 +178,7 @@ define([ * @alias PolylineVolumeGeometry * @constructor * + * @param {Object} options Object with the following properties: * @param {Cartesian3[]} options.polylinePositions An array of {@link Cartesain3} positions that define the center of the polyline volume. * @param {Number} options.shapePositions An array of {@link Cartesian2} positions that define the shape to be extruded along the polyline * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference. diff --git a/Source/Core/PolylineVolumeOutlineGeometry.js b/Source/Core/PolylineVolumeOutlineGeometry.js index 4eca1238548c..2df73e8c44b1 100644 --- a/Source/Core/PolylineVolumeOutlineGeometry.js +++ b/Source/Core/PolylineVolumeOutlineGeometry.js @@ -95,6 +95,7 @@ define([ * @alias PolylineVolumeOutlineGeometry * @constructor * + * @param {Object} options Object with the following properties: * @param {Cartesian3[]} options.polylinePositions An array of positions that define the center of the polyline volume. * @param {Number} options.shapePositions An array of positions that define the shape to be extruded along the polyline * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference. diff --git a/Source/Core/QuantizedMeshTerrainData.js b/Source/Core/QuantizedMeshTerrainData.js index 74ca1179c2e3..1e2df4e76d14 100644 --- a/Source/Core/QuantizedMeshTerrainData.js +++ b/Source/Core/QuantizedMeshTerrainData.js @@ -35,6 +35,7 @@ define([ * @alias QuantizedMeshTerrainData * @constructor * + * @param {Object} options Object with the following properties: * @param {Uint16Array} options.quantizedVertices The buffer containing the quantized mesh. * @param {Uint16Array} options.indices The indices specifying how the quantized vertices are linked * together into triangles. Each three indices specifies one triangle. diff --git a/Source/Core/QuaternionSpline.js b/Source/Core/QuaternionSpline.js index 2764d7f4fe66..764268ebf20f 100644 --- a/Source/Core/QuaternionSpline.js +++ b/Source/Core/QuaternionSpline.js @@ -69,6 +69,7 @@ define([ * @alias QuaternionSpline * @constructor * + * @param {Object} options Object with the following properties: * @param {Number[]} options.times An array of strictly increasing, unit-less, floating-point times at each point. * The values are in no way connected to the clock time. They are the parameterization for the curve. * @param {Quaternion[]} options.points The array of {@link Quaternion} control points. diff --git a/Source/Core/RectangleGeometry.js b/Source/Core/RectangleGeometry.js index 49435b16f134..2c18c473ba4a 100644 --- a/Source/Core/RectangleGeometry.js +++ b/Source/Core/RectangleGeometry.js @@ -621,6 +621,7 @@ define([ * @alias RectangleGeometry * @constructor * + * @param {Object} options Object with the following properties: * @param {Rectangle} options.rectangle A cartographic rectangle with north, south, east and west properties in radians. * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the rectangle lies. diff --git a/Source/Core/RectangleOutlineGeometry.js b/Source/Core/RectangleOutlineGeometry.js index 663c63affc31..c8b940af343e 100644 --- a/Source/Core/RectangleOutlineGeometry.js +++ b/Source/Core/RectangleOutlineGeometry.js @@ -267,6 +267,7 @@ define([ * @alias RectangleOutlineGeometry * @constructor * + * @param {Object} options Object with the following properties: * @param {Rectangle} options.rectangle A cartographic rectangle with north, south, east and west properties in radians. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the rectangle lies. * @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. diff --git a/Source/Core/SimplePolylineGeometry.js b/Source/Core/SimplePolylineGeometry.js index c14a0396bf90..32e2643e73bf 100644 --- a/Source/Core/SimplePolylineGeometry.js +++ b/Source/Core/SimplePolylineGeometry.js @@ -34,6 +34,7 @@ define([ * @alias SimplePolylineGeometry * @constructor * + * @param {Object} options Object with the following properties: * @param {Cartesian3[]} options.positions An array of {@link Cartesian3} defining the positions in the polyline as a line strip. * @param {Color[]} [options.colors] An Array of {@link Color} defining the per vertex or per segment colors. * @param {Boolean} [options.colorsPerVertex=false] A boolean that determines whether the colors will be flat across each segment of the line or interpolated across the vertices. diff --git a/Source/Core/SphereGeometry.js b/Source/Core/SphereGeometry.js index a949e40ca606..b45ba32a352e 100644 --- a/Source/Core/SphereGeometry.js +++ b/Source/Core/SphereGeometry.js @@ -15,6 +15,7 @@ define([ * @alias SphereGeometry * @constructor * + * @param {Object} [options] Object with the following properties: * @param {Number} [options.radius=1.0] The radius of the sphere. * @param {Number} [options.stackPartitions=64] The number of times to partition the ellipsoid into stacks. * @param {Number} [options.slicePartitions=64] The number of times to partition the ellipsoid into radial slices. diff --git a/Source/Core/SphereOutlineGeometry.js b/Source/Core/SphereOutlineGeometry.js index e917e0a1e94c..f4641632958a 100644 --- a/Source/Core/SphereOutlineGeometry.js +++ b/Source/Core/SphereOutlineGeometry.js @@ -15,6 +15,7 @@ define([ * @alias SphereOutlineGeometry * @constructor * + * @param {Object} [options] Object with the following properties: * @param {Number} [options.radius=1.0] The radius of the sphere. * @param {Number} [options.stackPartitions=10] The count of stacks for the sphere (1 greater than the number of parallel lines). * @param {Number} [options.slicePartitions=8] The count of slices for the sphere (Equal to the number of radial lines). diff --git a/Source/Core/Tipsify.js b/Source/Core/Tipsify.js index 970c4d44637e..e07ce888df71 100644 --- a/Source/Core/Tipsify.js +++ b/Source/Core/Tipsify.js @@ -28,6 +28,7 @@ define([ /** * Calculates the average cache miss ratio (ACMR) for a given set of indices. * + * @param {Object} options Object with the following properties: * @param {Number[]} options.indices Lists triads of numbers corresponding to the indices of the vertices * in the vertex buffer that define the geometry's triangles. * @param {Number} [options.maximumIndex] The maximum value of the elements in args.indices. diff --git a/Source/Core/VRTheWorldTerrainProvider.js b/Source/Core/VRTheWorldTerrainProvider.js index 477a54a3793b..2fb6bd5485ff 100644 --- a/Source/Core/VRTheWorldTerrainProvider.js +++ b/Source/Core/VRTheWorldTerrainProvider.js @@ -51,6 +51,7 @@ define([ * @alias VRTheWorldTerrainProvider * @constructor * + * @param {Object} options Object with the following properties: * @param {String} options.url The URL of the VR-TheWorld TileMap. * @param {Object} [options.proxy] A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL, if needed. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid. If this parameter is not diff --git a/Source/Core/WallGeometry.js b/Source/Core/WallGeometry.js index d2c889ba3684..7315e0517c01 100644 --- a/Source/Core/WallGeometry.js +++ b/Source/Core/WallGeometry.js @@ -49,13 +49,14 @@ define([ * @alias WallGeometry * @constructor * - * @param {Cartesian3[]} positions An array of Cartesian objects, which are the points of the wall. + * @param {Object} options Object with the following properties: + * @param {Cartesian3[]} options.positions An array of Cartesian objects, which are the points of the wall. * @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[]} [maximumHeights] An array parallel to positions that give the maximum height of the + * @param {Number[]} [options.maximumHeights] An array parallel to positions that give the maximum height of the * wall at positions. If undefined, the height of each position in used. - * @param {Number[]} [minimumHeights] An array parallel to positions that give the minimum height of the + * @param {Number[]} [options.minimumHeights] An array parallel to positions that give the minimum height of the * wall at positions. If undefined, the height at each position is 0.0. - * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid for coordinate manipulation + * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid for coordinate manipulation * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. * * @exception {DeveloperError} positions and maximumHeights must have the same length. @@ -86,13 +87,13 @@ define([ //>>includeStart('debug', pragmas.debug); if (!defined(wallPositions)) { - throw new DeveloperError('positions is required.'); + throw new DeveloperError('options.positions is required.'); } if (defined(maximumHeights) && maximumHeights.length !== wallPositions.length) { - throw new DeveloperError('positions and maximumHeights must have the same length.'); + throw new DeveloperError('options.positions and options.maximumHeights must have the same length.'); } if (defined(minimumHeights) && minimumHeights.length !== wallPositions.length) { - throw new DeveloperError('positions and minimumHeights must have the same length.'); + throw new DeveloperError('options.positions and options.minimumHeights must have the same length.'); } //>>includeEnd('debug'); diff --git a/Source/Core/WallOutlineGeometry.js b/Source/Core/WallOutlineGeometry.js index a8eee79c8a13..a5b5be9f68ad 100644 --- a/Source/Core/WallOutlineGeometry.js +++ b/Source/Core/WallOutlineGeometry.js @@ -41,13 +41,14 @@ define([ * @alias WallOutlineGeometry * @constructor * - * @param {Cartesian3[]} positions An array of Cartesian objects, which are the points of the wall. + * @param {Object} options Object with the following properties: + * @param {Cartesian3[]} options.positions An array of Cartesian objects, which are the points of the wall. * @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[]} [maximumHeights] An array parallel to positions that give the maximum height of the + * @param {Number[]} [options.maximumHeights] An array parallel to positions that give the maximum height of the * wall at positions. If undefined, the height of each position in used. - * @param {Number[]} [minimumHeights] An array parallel to positions that give the minimum height of the + * @param {Number[]} [options.minimumHeights] An array parallel to positions that give the minimum height of the * wall at positions. If undefined, the height at each position is 0.0. - * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid for coordinate manipulation + * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid for coordinate manipulation * * @exception {DeveloperError} positions and maximumHeights must have the same length. * @exception {DeveloperError} positions and minimumHeights must have the same length. @@ -77,13 +78,13 @@ define([ //>>includeStart('debug', pragmas.debug); if (!defined(wallPositions)) { - throw new DeveloperError('positions is required.'); + throw new DeveloperError('options.positions is required.'); } if (defined(maximumHeights) && maximumHeights.length !== wallPositions.length) { - throw new DeveloperError('positions and maximumHeights must have the same length.'); + throw new DeveloperError('options.positions and options.maximumHeights must have the same length.'); } if (defined(minimumHeights) && minimumHeights.length !== wallPositions.length) { - throw new DeveloperError('positions and minimumHeights must have the same length.'); + throw new DeveloperError('options.positions and options.minimumHeights must have the same length.'); } //>>includeEnd('debug'); diff --git a/Source/Core/WebMercatorTilingScheme.js b/Source/Core/WebMercatorTilingScheme.js index 7076c0af9e25..b2b2d505b359 100644 --- a/Source/Core/WebMercatorTilingScheme.js +++ b/Source/Core/WebMercatorTilingScheme.js @@ -26,6 +26,7 @@ define([ * @alias WebMercatorTilingScheme * @constructor * + * @param {Object} [options] Object with the following properties: * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid whose surface is being tiled. Defaults to * the WGS84 ellipsoid. * @param {Number} [options.numberOfLevelZeroTilesX=1] The number of tiles in the X direction at level zero of diff --git a/Source/Core/jsonp.js b/Source/Core/jsonp.js index 60a5e515f2a5..0c0586075973 100644 --- a/Source/Core/jsonp.js +++ b/Source/Core/jsonp.js @@ -21,6 +21,7 @@ define([ * @exports jsonp * * @param {String} url The URL to request. + * @param {Object} [options] Object with the following properties: * @param {Object} [options.parameters] Any extra query parameters to append to the URL. * @param {String} [options.callbackParameterName='callback'] The callback parameter name that the server expects. * @param {Object} [options.proxy] A proxy to use for the request. This object is expected to have a getURL function which returns the proxied URL, if needed. diff --git a/Source/Core/loadWithXhr.js b/Source/Core/loadWithXhr.js index dd2fd6443070..df8b25d2c587 100644 --- a/Source/Core/loadWithXhr.js +++ b/Source/Core/loadWithXhr.js @@ -21,7 +21,7 @@ define([ * * @exports loadWithXhr * - * @param {Object} options Options for the request. + * @param {Object} options Object with the following properties: * @param {String|Promise} options.url The URL of the data, or a promise for the URL. * @param {String} [options.responseType] The type of response. This controls the type of item returned. * @param {String} [options.method='GET'] The HTTP method to use. diff --git a/Source/Core/writeTextToCanvas.js b/Source/Core/writeTextToCanvas.js index 6849d259d435..16a5216a618f 100644 --- a/Source/Core/writeTextToCanvas.js +++ b/Source/Core/writeTextToCanvas.js @@ -18,6 +18,7 @@ define([ * If text is blank, returns undefined. * * @param {String} text The text to write. + * @param {Object} [options] Object with the following properties: * @param {String} [options.font='10px sans-serif'] The CSS font to use. * @param {String} [options.textBaseline='bottom'] The baseline of the text. * @param {Boolean} [options.fill=true] Whether to fill the text. diff --git a/Source/DynamicScene/SampledPositionProperty.js b/Source/DynamicScene/SampledPositionProperty.js index d9579cf41d93..ea2ebe5d703d 100644 --- a/Source/DynamicScene/SampledPositionProperty.js +++ b/Source/DynamicScene/SampledPositionProperty.js @@ -144,7 +144,7 @@ define([ * Sets the algorithm and degree to use when interpolating a position. * @memberof SampledPositionProperty * - * @param {Object} options The options + * @param {Object} [options] Object with the following properties: * @param {InterpolationAlgorithm} [options.interpolationAlgorithm] The new interpolation algorithm. If undefined, the existing property will be unchanged. * @param {Number} [options.interpolationDegree] The new interpolation degree. If undefined, the existing property will be unchanged. */ diff --git a/Source/DynamicScene/SampledProperty.js b/Source/DynamicScene/SampledProperty.js index 4efd988d8d98..856cf3f2eae0 100644 --- a/Source/DynamicScene/SampledProperty.js +++ b/Source/DynamicScene/SampledProperty.js @@ -355,7 +355,7 @@ define([ * Sets the algorithm and degree to use when interpolating a value. * @memberof SampledProperty * - * @param {Object} options The options + * @param {Object} [options] Object with the following properties: * @param {InterpolationAlgorithm} [options.interpolationAlgorithm] The new interpolation algorithm. If undefined, the existing property will be unchanged. * @param {Number} [options.interpolationDegree] The new interpolation degree. If undefined, the existing property will be unchanged. */ diff --git a/Source/Renderer/createShaderSource.js b/Source/Renderer/createShaderSource.js index 393bcf18f9f8..f682e58a7b35 100644 --- a/Source/Renderer/createShaderSource.js +++ b/Source/Renderer/createShaderSource.js @@ -24,6 +24,7 @@ define([ * * @exports createShaderSource * + * @param {Object} [options] Object with the following properties: * @param {String[]} [options.defines] An array of strings to combine containing GLSL identifiers to #define. * @param {String[]} [options.sources] An array of strings to combine containing GLSL code for the shader. * @param {String} [options.pickColorQualifier] The GLSL qualifier, uniform or varying, for the input czm_pickColor. When defined, a pick fragment shader is generated. diff --git a/Source/Scene/ArcGisMapServerImageryProvider.js b/Source/Scene/ArcGisMapServerImageryProvider.js index 8a362256c0e0..a7c63dc23db8 100644 --- a/Source/Scene/ArcGisMapServerImageryProvider.js +++ b/Source/Scene/ArcGisMapServerImageryProvider.js @@ -44,6 +44,7 @@ define([ * @alias ArcGisMapServerImageryProvider * @constructor * + * @param {Object} options Object with the following properties: * @param {String} options.url The URL of the ArcGIS MapServer service. * @param {TileDiscardPolicy} [options.tileDiscardPolicy] The policy that determines if a tile * is invalid and should be discarded. If this value is not specified, a default diff --git a/Source/Scene/BillboardCollection.js b/Source/Scene/BillboardCollection.js index 624c131a5d8a..313fddfe7059 100644 --- a/Source/Scene/BillboardCollection.js +++ b/Source/Scene/BillboardCollection.js @@ -107,6 +107,7 @@ define([ * @alias BillboardCollection * @constructor * + * @param {Object} [options] Object with the following properties: * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The 4x4 transformation matrix that transforms each billboard from model to world coordinates. * @param {Boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown. * diff --git a/Source/Scene/BingMapsImageryProvider.js b/Source/Scene/BingMapsImageryProvider.js index 926af20e4290..e359d5c77a04 100644 --- a/Source/Scene/BingMapsImageryProvider.js +++ b/Source/Scene/BingMapsImageryProvider.js @@ -43,6 +43,7 @@ define([ * @alias BingMapsImageryProvider * @constructor * + * @param {Object} options Object with the following properties: * @param {String} options.url The url of the Bing Maps server hosting the imagery. * @param {String} [options.key] The Bing Maps key for your application, which can be * created at {@link https://www.bingmapsportal.com/}. diff --git a/Source/Scene/CameraFlightPath.js b/Source/Scene/CameraFlightPath.js index b2b351095447..8e64e417bc6b 100644 --- a/Source/Scene/CameraFlightPath.js +++ b/Source/Scene/CameraFlightPath.js @@ -393,6 +393,7 @@ define([ * be given in world coordinates. * * @param {Scene} scene The scene instance to use. + * @param {Object} options Object with the following properties: * @param {Cartesian3} options.destination The final position of the camera. * @param {Cartesian3} [options.direction] The final direction of the camera. By default, the direction will point towards the center of the frame in 3D and in the negative z direction in Columbus view or 2D. * @param {Cartesian3} [options.up] The final up direction. By default, the up direction will point towards local north in 3D and in the positive y direction in Columbus view or 2D. diff --git a/Source/Scene/DebugAppearance.js b/Source/Scene/DebugAppearance.js index 3e679c2279c9..32ffdfee017d 100644 --- a/Source/Scene/DebugAppearance.js +++ b/Source/Scene/DebugAppearance.js @@ -24,6 +24,7 @@ define([ * @alias DebugAppearance * @constructor * + * @param {Object} options Object with the following properties: * @param {String} options.attributeName The name of the attribute to visualize. * @param {String} [options.glslDatatype='vec3'] The GLSL datatype of the attribute. Supported datatypes are float, vec2, vec3, and vec4. * @param {String} [options.vertexShaderSource] Optional GLSL vertex shader source to override the default vertex shader. diff --git a/Source/Scene/DebugModelMatrixPrimitive.js b/Source/Scene/DebugModelMatrixPrimitive.js index 7cc0084cdd7d..4b1dda4cf2e6 100644 --- a/Source/Scene/DebugModelMatrixPrimitive.js +++ b/Source/Scene/DebugModelMatrixPrimitive.js @@ -37,6 +37,7 @@ define([ * @alias DebugModelMatrixPrimitive * @constructor * + * @param {Object} [options] Object with the following properties: * @param {Number} [options.length=10000000.0] The length of the axes in meters. * @param {Number} [options.width=2.0] The width of the axes in pixels. * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The 4x4 matrix that defines the reference frame, i.e., origin plus axes, to visualize. diff --git a/Source/Scene/DiscardMissingTileImagePolicy.js b/Source/Scene/DiscardMissingTileImagePolicy.js index 15729f16f67b..5a68d05c3ca3 100644 --- a/Source/Scene/DiscardMissingTileImagePolicy.js +++ b/Source/Scene/DiscardMissingTileImagePolicy.js @@ -22,6 +22,7 @@ define([ * @alias DiscardMissingTileImagePolicy * @constructor * + * @param {Object} options Object with the following properties: * @param {String} options.missingImageUrl The URL of the known missing image. * @param {Cartesian2[]} options.pixelsToCheck An array of {@link Cartesian2} pixel positions to * compare against the missing image. diff --git a/Source/Scene/EllipsoidPrimitive.js b/Source/Scene/EllipsoidPrimitive.js index 274196f86b05..90382982222a 100644 --- a/Source/Scene/EllipsoidPrimitive.js +++ b/Source/Scene/EllipsoidPrimitive.js @@ -56,6 +56,7 @@ define([ * @alias EllipsoidPrimitive * @constructor * + * @param {Object} [options] Object with the following properties: * @param {Cartesian3} [options.center=Cartesian3.ZERO] The center of the ellipsoid in the ellipsoid's model coordinates. * @param {Cartesian3} [options.radii] The radius of the ellipsoid along the x, y, and z axes in the ellipsoid's model coordinates. * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The 4x4 transformation matrix that transforms the ellipsoid from model to world coordinates. diff --git a/Source/Scene/EllipsoidSurfaceAppearance.js b/Source/Scene/EllipsoidSurfaceAppearance.js index fdb04de11d4b..468c68a3ee90 100644 --- a/Source/Scene/EllipsoidSurfaceAppearance.js +++ b/Source/Scene/EllipsoidSurfaceAppearance.js @@ -29,6 +29,7 @@ define([ * @alias EllipsoidSurfaceAppearance * @constructor * + * @param {Object} [options] Object with the following properties: * @param {Boolean} [options.flat=false] When true, flat shading is used in the fragment shader, which means lighting is not taking into account. * @param {Boolean} [options.faceForward=options.aboveGround] When true, the fragment shader flips the surface normal as needed to ensure that the normal faces the viewer to avoid dark spots. This is useful when both sides of a geometry should be shaded like {@link WallGeometry}. * @param {Boolean} [options.translucent=true] When true, the geometry is expected to appear translucent so {@link EllipsoidSurfaceAppearance#renderState} has alpha blending enabled. diff --git a/Source/Scene/GoogleEarthImageryProvider.js b/Source/Scene/GoogleEarthImageryProvider.js index 2a4c075694fe..dbbbaac5de8b 100644 --- a/Source/Scene/GoogleEarthImageryProvider.js +++ b/Source/Scene/GoogleEarthImageryProvider.js @@ -46,6 +46,7 @@ define([ * @alias GoogleEarthImageryProvider * @constructor * + * @param {Object} options Object with the following properties: * @param {String} options.url The url of the Google Earth server hosting the imagery. * @param {Number} options.channel The channel (id) to be used when requesting data from the server. * The channel number can be found by looking at the json file located at: diff --git a/Source/Scene/GridImageryProvider.js b/Source/Scene/GridImageryProvider.js index 39e53e67550a..40dc639bf108 100644 --- a/Source/Scene/GridImageryProvider.js +++ b/Source/Scene/GridImageryProvider.js @@ -20,6 +20,7 @@ define([ * @alias GridImageryProvider * @constructor * + * @param {Object} [options] Object with the following properties: * @param {TilingScheme} [options.tilingScheme=new GeographicTilingScheme()] The tiling scheme for which to draw tiles. * @param {Number} [options.cells=8] The number of grids cells. * @param {Color} [options.color=Color(1.0, 1.0, 1.0, 0.4)] The color to draw grid lines. diff --git a/Source/Scene/ImageryLayer.js b/Source/Scene/ImageryLayer.js index 39122bd15438..ba82d407f835 100644 --- a/Source/Scene/ImageryLayer.js +++ b/Source/Scene/ImageryLayer.js @@ -75,6 +75,7 @@ define([ * @constructor * * @param {ImageryProvider} imageryProvider The imagery provider to use. + * @param {Object} [options] Object with the following properties: * @param {Rectangle} [options.rectangle=imageryProvider.rectangle] The rectangle of the layer. This rectangle * can limit the visible portion of the imagery provider. * @param {Number|Function} [options.alpha=1.0] The alpha blending value of this layer, from 0.0 to 1.0. diff --git a/Source/Scene/LabelCollection.js b/Source/Scene/LabelCollection.js index 26bd7577abd5..28f69f336092 100644 --- a/Source/Scene/LabelCollection.js +++ b/Source/Scene/LabelCollection.js @@ -279,6 +279,7 @@ define([ * @alias LabelCollection * @constructor * + * @param {Object} [options] Object with the following properties: * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The 4x4 transformation matrix that transforms each label from model to world coordinates. * @param {Boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown. * diff --git a/Source/Scene/Material.js b/Source/Scene/Material.js index b97bbc1a7224..9966f604d0e1 100644 --- a/Source/Scene/Material.js +++ b/Source/Scene/Material.js @@ -241,6 +241,7 @@ define([ * * @alias Material * + * @param {Object} [options] Object with the following properties: * @param {Boolean} [options.strict=false] Throws errors for issues that would normally be ignored, including unused uniforms or materials. * @param {Boolean|Function} [options.translucent=true] When true or a function that returns true, the geometry * with this material is expected to appear translucent. diff --git a/Source/Scene/MaterialAppearance.js b/Source/Scene/MaterialAppearance.js index fe9e5024e801..a072b30ae8dc 100644 --- a/Source/Scene/MaterialAppearance.js +++ b/Source/Scene/MaterialAppearance.js @@ -36,6 +36,7 @@ define([ * @alias MaterialAppearance * @constructor * + * @param {Object} [options] Object with the following properties: * @param {Boolean} [options.flat=false] When true, flat shading is used in the fragment shader, which means lighting is not taking into account. * @param {Boolean} [options.faceForward=!options.closed] When true, the fragment shader flips the surface normal as needed to ensure that the normal faces the viewer to avoid dark spots. This is useful when both sides of a geometry should be shaded like {@link WallGeometry}. * @param {Boolean} [options.translucent=true] When true, the geometry is expected to appear translucent so {@link MaterialAppearance#renderState} has alpha blending enabled. diff --git a/Source/Scene/Model.js b/Source/Scene/Model.js index 7562d4e1dc85..40d06d49ec9f 100644 --- a/Source/Scene/Model.js +++ b/Source/Scene/Model.js @@ -152,6 +152,7 @@ define([ * @alias Model * @constructor * + * @param {Object} [options] Object with the following properties: * @param {Object} [options.gltf] The object for the glTF JSON. * @param {String} [options.basePath=''] The base path that paths in the glTF JSON are relative to. * @param {Boolean} [options.show=true] Determines if the model primitive will be shown. @@ -469,6 +470,7 @@ define([ * * @memberof Model * + * @param {Object} options Object with the following properties: * @param {String} options.url The url to the glTF .json file. * @param {Object} [options.headers] HTTP headers to send with the request. * @param {Boolean} [options.show=true] Determines if the model primitive will be shown. diff --git a/Source/Scene/ModelAnimationCollection.js b/Source/Scene/ModelAnimationCollection.js index 09fe223723f1..793d39376969 100644 --- a/Source/Scene/ModelAnimationCollection.js +++ b/Source/Scene/ModelAnimationCollection.js @@ -91,6 +91,7 @@ define([ * * @memberof ModelAnimationCollection * + * @param {Object} options Object with the following properties: * @param {String} options.name The glTF animation name that identifies the animation. * @param {JulianDate} [options.startTime] The scene time to start playing the animation. When this is undefined, the animation starts at the next frame. * @param {Number} [options.startOffset=0.0] The offset, in seconds, from startTime to start playing. @@ -175,6 +176,7 @@ define([ * * @memberof ModelAnimationCollection * + * @param {Object} [options] Object with the following properties: * @param {JulianDate} [options.startTime] The scene time to start playing the animations. When this is undefined, the animations starts at the next frame. * @param {Number} [options.startOffset=0.0] The offset, in seconds, from startTime to start playing. * @param {JulianDate} [options.stopTime] The scene time to stop playing the animations. When this is undefined, the animations are played for its full duration. diff --git a/Source/Scene/Moon.js b/Source/Scene/Moon.js index d76a30df5060..7b25acc33678 100644 --- a/Source/Scene/Moon.js +++ b/Source/Scene/Moon.js @@ -34,6 +34,7 @@ define([ * @alias Moon * @constructor * + * @param {Object} [options] Object with the following properties: * @param {Boolean} [options.show=true] Determines whether the moon will be rendered. * @param {String} [options.textureUrl=buildModuleUrl('Assets/Textures/moonSmall.jpg')] The moon texture. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.MOON] The moon ellipsoid. diff --git a/Source/Scene/OpenStreetMapImageryProvider.js b/Source/Scene/OpenStreetMapImageryProvider.js index 7059fb43ccde..9285116d633a 100644 --- a/Source/Scene/OpenStreetMapImageryProvider.js +++ b/Source/Scene/OpenStreetMapImageryProvider.js @@ -33,6 +33,7 @@ define([ * @alias OpenStreetMapImageryProvider * @constructor * + * @param {Object} [options] Object with the following properties: * @param {String} [options.url='//a.tile.openstreetmap.org'] The OpenStreetMap server url. * @param {String} [options.fileExtension='png'] The file extension for images on the server. * @param {Object} [options.proxy] A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL. diff --git a/Source/Scene/PerInstanceColorAppearance.js b/Source/Scene/PerInstanceColorAppearance.js index 1e9ef78fd495..56356d578ef2 100644 --- a/Source/Scene/PerInstanceColorAppearance.js +++ b/Source/Scene/PerInstanceColorAppearance.js @@ -27,6 +27,7 @@ define([ * @alias PerInstanceColorAppearance * @constructor * + * @param {Object} [options] Object with the following properties: * @param {Boolean} [options.flat=false] When true, flat shading is used in the fragment shader, which means lighting is not taking into account. * @param {Boolean} [options.faceForward=!options.closed] When true, the fragment shader flips the surface normal as needed to ensure that the normal faces the viewer to avoid dark spots. This is useful when both sides of a geometry should be shaded like {@link WallGeometry}. * @param {Boolean} [options.translucent=true] When true, the geometry is expected to appear translucent so {@link PerInstanceColorAppearance#renderState} has alpha blending enabled. diff --git a/Source/Scene/Polygon.js b/Source/Scene/Polygon.js index 96f655379216..159ba9ba3f3f 100644 --- a/Source/Scene/Polygon.js +++ b/Source/Scene/Polygon.js @@ -35,6 +35,7 @@ define([ * @alias Polygon * @constructor * + * @param {Object} [options] Object with the following properties: * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid that the polygon is drawn on. * @param {Cartesian3[]} [options.positions] The cartesian positions of the polygon. * @param {Object} [options.polygonHierarchy] An object defining the vertex positions of each nested polygon as defined in {@link Polygon#configureFromPolygonHierarchy}. diff --git a/Source/Scene/Polyline.js b/Source/Scene/Polyline.js index 77ed919511c1..e9a5340cde66 100644 --- a/Source/Scene/Polyline.js +++ b/Source/Scene/Polyline.js @@ -29,6 +29,7 @@ define([ * @alias Polyline * @internalConstructor * + * @param {Object} [options] Object with the following properties: * @param {Boolean} [options.show=true] true if this polyline will be shown; otherwise, false. * @param {Number} [options.width=1.0] The width of the polyline in pixels. * @param {Boolean} [options.loop=false] Whether a line segment will be added between the last and first line positions to make this line a loop. diff --git a/Source/Scene/PolylineCollection.js b/Source/Scene/PolylineCollection.js index 2be89ea04216..369cd76609e4 100644 --- a/Source/Scene/PolylineCollection.js +++ b/Source/Scene/PolylineCollection.js @@ -95,6 +95,7 @@ define([ * @alias PolylineCollection * @constructor * + * @param {Object} [options] Object with the following properties: * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The 4x4 transformation matrix that transforms each polyline from model to world coordinates. * @param {Boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown. * diff --git a/Source/Scene/PolylineColorAppearance.js b/Source/Scene/PolylineColorAppearance.js index 24f518cdff0b..bc7a3e3453be 100644 --- a/Source/Scene/PolylineColorAppearance.js +++ b/Source/Scene/PolylineColorAppearance.js @@ -27,6 +27,7 @@ define([ * @alias PolylineColorAppearance * @constructor * + * @param {Object} [options] Object with the following properties: * @param {Boolean} [options.translucent=true] When true, the geometry is expected to appear translucent so {@link PolylineColorAppearance#renderState} has alpha blending enabled. * @param {String} [options.vertexShaderSource] Optional GLSL vertex shader source to override the default vertex shader. * @param {String} [options.fragmentShaderSource] Optional GLSL fragment shader source to override the default fragment shader. diff --git a/Source/Scene/PolylineMaterialAppearance.js b/Source/Scene/PolylineMaterialAppearance.js index 42c571eddf29..a4e01859ef2f 100644 --- a/Source/Scene/PolylineMaterialAppearance.js +++ b/Source/Scene/PolylineMaterialAppearance.js @@ -29,6 +29,7 @@ define([ * @alias PolylineMaterialAppearance * @constructor * + * @param {Object} [options] Object with the following properties: * @param {Boolean} [options.translucent=true] When true, the geometry is expected to appear translucent so {@link PolylineMaterialAppearance#renderState} has alpha blending enabled. * @param {Material} [options.material=Material.ColorType] The material used to determine the fragment color. * @param {String} [options.vertexShaderSource] Optional GLSL vertex shader source to override the default vertex shader. diff --git a/Source/Scene/Primitive.js b/Source/Scene/Primitive.js index b2693aa96e4c..65cbef4cdb6a 100644 --- a/Source/Scene/Primitive.js +++ b/Source/Scene/Primitive.js @@ -79,6 +79,7 @@ define([ * @alias Primitive * @constructor * + * @param {Object} [options] Object with the following properties: * @param {Array|GeometryInstance} [options.geometryInstances] The geometry instances - or a single geometry instance - to render. * @param {Appearance} [options.appearance] The appearance used to render the primitive. * @param {Boolean} [options.show=true] Determines if this primitive will be shown. diff --git a/Source/Scene/PrimitiveCollection.js b/Source/Scene/PrimitiveCollection.js index 3b5bccfa4a19..e7f9c1beac5e 100644 --- a/Source/Scene/PrimitiveCollection.js +++ b/Source/Scene/PrimitiveCollection.js @@ -23,6 +23,7 @@ define([ * @alias PrimitiveCollection * @constructor * + * @param {Object} [options] Object with the following properties: * @param {Boolean} [options.show=true] Determines if the primitives in the collection will be shown. * @param {Boolean} [options.destroyPrimitives=true] Determines if primitives in the collection are destroyed when they are removed. * diff --git a/Source/Scene/RectanglePrimitive.js b/Source/Scene/RectanglePrimitive.js index 77b5506db1e8..35d62ad0adb7 100644 --- a/Source/Scene/RectanglePrimitive.js +++ b/Source/Scene/RectanglePrimitive.js @@ -35,6 +35,7 @@ define([ * @alias RectanglePrimitive * @constructor * + * @param {Object} [options] Object with the following properties: * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid that the rectangle is drawn on. * @param {Rectangle} [options.rectangle] The rectangle, which defines the rectangular region to draw. * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude in the underlying geometry. diff --git a/Source/Scene/SingleTileImageryProvider.js b/Source/Scene/SingleTileImageryProvider.js index fea93c1b9604..3e66df4f89d2 100644 --- a/Source/Scene/SingleTileImageryProvider.js +++ b/Source/Scene/SingleTileImageryProvider.js @@ -32,6 +32,7 @@ define([ * @alias SingleTileImageryProvider * @constructor * + * @param {Object} options Object with the following properties: * @param {String} options.url The url for the tile. * @param {Rectangle} [options.rectangle=Rectangle.MAX_VALUE] The rectangle, in radians, covered by the image. * @param {Credit|String} [options.credit] A credit for the data source, which is displayed on the canvas. diff --git a/Source/Scene/SkyBox.js b/Source/Scene/SkyBox.js index 1658f9be9be5..f181cdbe603b 100644 --- a/Source/Scene/SkyBox.js +++ b/Source/Scene/SkyBox.js @@ -44,6 +44,7 @@ define([ * @alias SkyBox * @constructor * + * @param {Object} options Object with the following properties: * @param {Object} [options.sources] The source URL or Image object for each of the six cube map faces. See the example below. * @param {Boolean} [options.show=true] Determines if this primitive will be shown. * diff --git a/Source/Scene/TextureAtlas.js b/Source/Scene/TextureAtlas.js index 1f76c3885937..b4601260f5a9 100644 --- a/Source/Scene/TextureAtlas.js +++ b/Source/Scene/TextureAtlas.js @@ -43,6 +43,7 @@ define([ * @alias TextureAtlas * @constructor * + * @param {Object} options Object with the following properties: * @param {Scene} options.scene The scene in which the texture gets created. * @param {PixelFormat} [options.pixelFormat=PixelFormat.RGBA] The pixel format of the texture. * @param {Number} [options.borderWidthInPixels=1] The amount of spacing between adjacent images in pixels. diff --git a/Source/Scene/TileCoordinatesImageryProvider.js b/Source/Scene/TileCoordinatesImageryProvider.js index 6fded664e45f..fe559d4b17b1 100644 --- a/Source/Scene/TileCoordinatesImageryProvider.js +++ b/Source/Scene/TileCoordinatesImageryProvider.js @@ -21,6 +21,7 @@ define([ * @alias TileCoordinatesImageryProvider * @constructor * + * @param {Object} [options] Object with the following properties: * @param {TilingScheme} [options.tilingScheme=new GeographicTilingScheme()] The tiling scheme for which to draw tiles. * @param {Color} [options.color=Color.YELLOW] The color to draw the tile box and label. * @param {Number} [options.tileWidth=256] The width of the tile for level-of-detail selection purposes. diff --git a/Source/Scene/TileMapServiceImageryProvider.js b/Source/Scene/TileMapServiceImageryProvider.js index ca7c76d2442b..005fd5a66a5e 100644 --- a/Source/Scene/TileMapServiceImageryProvider.js +++ b/Source/Scene/TileMapServiceImageryProvider.js @@ -35,6 +35,7 @@ define([ * @alias TileMapServiceImageryProvider * @constructor * + * @param {Object} [options] Object with the following properties: * @param {String} [options.url='.'] Path to image tiles on server. * @param {String} [options.fileExtension='png'] The file extension for images on the server. * @param {Object} [options.proxy] A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL. diff --git a/Source/Scene/WebMapServiceImageryProvider.js b/Source/Scene/WebMapServiceImageryProvider.js index b9b6c20e0d11..168e3ebb2309 100644 --- a/Source/Scene/WebMapServiceImageryProvider.js +++ b/Source/Scene/WebMapServiceImageryProvider.js @@ -31,6 +31,7 @@ define([ * @alias WebMapServiceImageryProvider * @constructor * + * @param {Object} options Object with the following properties: * @param {String} options.url The URL of the WMS service. * @param {String} options.layers The layers to include, separated by commas. * @param {Object} [options.parameters=WebMapServiceImageryProvider.DefaultParameters] Additional parameters to pass to the WMS server in the GetMap URL. diff --git a/Source/Scene/createTangentSpaceDebugPrimitive.js b/Source/Scene/createTangentSpaceDebugPrimitive.js index b5635ae8f7cf..9db7e2b51a7a 100644 --- a/Source/Scene/createTangentSpaceDebugPrimitive.js +++ b/Source/Scene/createTangentSpaceDebugPrimitive.js @@ -29,6 +29,7 @@ define([ * * @exports createTangentSpaceDebugPrimitive * + * @param {Object} options Object with the following properties: * @param {Geometry} options.geometry The Geometry instance with the attribute. * @param {Number} [options.length=10000.0] The length of each line segment in meters. This can be negative to point the vector in the opposite direction. * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The model matrix that transforms to transform the geometry from model to world coordinates. diff --git a/Source/Widgets/BaseLayerPicker/BaseLayerPicker.js b/Source/Widgets/BaseLayerPicker/BaseLayerPicker.js index ef08cdd7dc9b..4eefe1414430 100644 --- a/Source/Widgets/BaseLayerPicker/BaseLayerPicker.js +++ b/Source/Widgets/BaseLayerPicker/BaseLayerPicker.js @@ -34,6 +34,7 @@ define([ * @constructor * * @param {Element} container The parent HTML container node for this widget. + * @param {Object} options Object with the following properties: * @param {Globe} options.globe The Globe to use. * @param {ProviderViewModel[]} [options.imageryProviderViewModels=[]] The array of ProviderViewModel instances to use for imagery. * @param {ProviderViewModel} [options.selectedImageryProviderViewModel] The view model for the current base imagery layer, if not supplied the first available imagery layer is used. diff --git a/Source/Widgets/BaseLayerPicker/BaseLayerPickerViewModel.js b/Source/Widgets/BaseLayerPicker/BaseLayerPickerViewModel.js index a1fc1d00403c..a187d52dba0a 100644 --- a/Source/Widgets/BaseLayerPicker/BaseLayerPickerViewModel.js +++ b/Source/Widgets/BaseLayerPicker/BaseLayerPickerViewModel.js @@ -24,6 +24,7 @@ define([ * @alias BaseLayerPickerViewModel * @constructor * + * @param {Object} options Object with the following properties: * @param {Globe} options.globe The Globe to use. * @param {ProviderViewModel[]} [options.imageryProviderViewModels=[]] The array of ProviderViewModel instances to use for imagery. * @param {ProviderViewModel} [options.selectedImageryProviderViewModel] The view model for the current base imagery layer, if not supplied the first available imagery layer is used. diff --git a/Source/Widgets/CesiumWidget/CesiumWidget.js b/Source/Widgets/CesiumWidget/CesiumWidget.js index c9c7320c7e1f..06cbc42876ad 100644 --- a/Source/Widgets/CesiumWidget/CesiumWidget.js +++ b/Source/Widgets/CesiumWidget/CesiumWidget.js @@ -98,7 +98,7 @@ define([ * @constructor * * @param {Element|String} container The DOM element or ID that will contain the widget. - * @param {Object} [options] Configuration options for the widget. + * @param {Object} [options] Object with the following properties: * @param {Clock} [options.clock=new Clock()] The clock to use to control current time. * @param {ImageryProvider} [options.imageryProvider=new BingMapsImageryProvider()] The imagery provider to serve as the base layer. If set to false, no imagery provider will be added. * @param {TerrainProvider} [options.terrainProvider=new EllipsoidTerrainProvider] The terrain provider. diff --git a/Source/Widgets/Geocoder/Geocoder.js b/Source/Widgets/Geocoder/Geocoder.js index 7ad5b68bd711..d812ca24718f 100644 --- a/Source/Widgets/Geocoder/Geocoder.js +++ b/Source/Widgets/Geocoder/Geocoder.js @@ -27,6 +27,7 @@ define([ * @alias Geocoder * @constructor * + * @param {Object} options Object with the following properties: * @param {Element|String} options.container The DOM element or ID that will contain the widget. * @param {Scene} options.scene The Scene instance to use. * @param {String} [options.url='//dev.virtualearth.net'] The base URL of the Bing Maps API. diff --git a/Source/Widgets/Geocoder/GeocoderViewModel.js b/Source/Widgets/Geocoder/GeocoderViewModel.js index 917697311096..adaf599bd770 100644 --- a/Source/Widgets/Geocoder/GeocoderViewModel.js +++ b/Source/Widgets/Geocoder/GeocoderViewModel.js @@ -36,6 +36,7 @@ define([ * @alias GeocoderViewModel * @constructor * + * @param {Object} options Object with the following properties: * @param {Scene} options.scene The Scene instance to use. * @param {String} [options.url='//dev.virtualearth.net'] The base URL of the Bing Maps API. * @param {String} [options.key] The Bing Maps key for your application, which can be diff --git a/Source/Widgets/NavigationHelpButton/NavigationHelpButton.js b/Source/Widgets/NavigationHelpButton/NavigationHelpButton.js index c031deb955d1..2f1dc582fea6 100644 --- a/Source/Widgets/NavigationHelpButton/NavigationHelpButton.js +++ b/Source/Widgets/NavigationHelpButton/NavigationHelpButton.js @@ -26,6 +26,7 @@ define([ * @alias NavigationHelpButton * @constructor * + * @param {Object} options Object with the following properties: * @param {Element|String} options.container The DOM element or ID that will contain the widget. * @param {Boolean} [options.instructionsInitiallyVisible=false] True if the navigation instructions should initially be visible; otherwise, false. * diff --git a/Source/Widgets/ToggleButtonViewModel.js b/Source/Widgets/ToggleButtonViewModel.js index 32f372e03818..1825efdcf67c 100644 --- a/Source/Widgets/ToggleButtonViewModel.js +++ b/Source/Widgets/ToggleButtonViewModel.js @@ -19,7 +19,7 @@ define([ * @constructor * * @param {Command} command The command which will be executed when the button is toggled. - * @param {Object} [options] Options defining the button's properties. + * @param {Object} [options] Object with the following properties: * @param {Boolean} [options.toggled=false] A boolean indicating whether the button should be initially toggled. * @param {String} [options.tooltip=''] A string containing the button's tooltip. */ diff --git a/Source/Widgets/Viewer/Viewer.js b/Source/Widgets/Viewer/Viewer.js index e98a4d04722c..8bd930bb0f83 100644 --- a/Source/Widgets/Viewer/Viewer.js +++ b/Source/Widgets/Viewer/Viewer.js @@ -69,7 +69,7 @@ define([ * @constructor * * @param {Element|String} container The DOM element or ID that will contain the widget. - * @param {Object} [options] Configuration options for the widget. + * @param {Object} [options] Object with the following properties: * @param {Boolean} [options.animation=true] If set to false, the Animation widget will not be created. * @param {Boolean} [options.baseLayerPicker=true] If set to false, the BaseLayerPicker widget will not be created. * @param {Boolean} [options.fullscreenButton=true] If set to false, the FullscreenButton widget will not be created. diff --git a/Source/Widgets/Viewer/viewerDragDropMixin.js b/Source/Widgets/Viewer/viewerDragDropMixin.js index f230f44ed79d..388d73df1144 100644 --- a/Source/Widgets/Viewer/viewerDragDropMixin.js +++ b/Source/Widgets/Viewer/viewerDragDropMixin.js @@ -28,7 +28,7 @@ define([ * @exports viewerDragDropMixin * * @param {Viewer} viewer The viewer instance. - * @param {Object} [options] Configuration options for the mixin. + * @param {Object} [options] Object with the following properties: * @param {Element|String} [options.dropTarget=viewer.container] The DOM element which will serve as the drop target. * @param {Boolean} [options.clearOnDrop=true] When true, dropping files will clear all existing data sources first, when false, new data sources will be loaded after the existing ones. *