Skip to content

Commit 2ffac63

Browse files
authored
Merge pull request #12942 from porotkin/fix-jsdoc
JSDoc. Fix `Google2DImageryProvider.ConstructorOptions` generated type
2 parents d4b8184 + e80302f commit 2ffac63

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

CONTRIBUTORS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -432,3 +432,4 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to Cesiu
432432
- [Pamela Augustine](https://github.com/pamelaAugustine)
433433
- [宋时旺](https://github.com/BlockCnFuture)
434434
- [Marco Zhan](https://github.com/marcoYxz)
435+
- [Mikhail Porotkin](https://github.com/porotkin)

packages/engine/Source/Scene/Google2DImageryProvider.js

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,17 @@ const trailingSlashRegex = /\/$/;
1515
*
1616
* Initialization options for the Google2DImageryProvider constructor
1717
*
18-
* @property {object} options Object with the following properties:
19-
* @property {string} options.key The Google api key to send with tile requests.
20-
* @property {string} options.session The Google session token that tracks the current state of your map and viewport.
21-
* @property {string|Resource|IonResource} options.url The Google 2D maps endpoint.
22-
* @property {string} options.tileWidth The width of each tile in pixels.
23-
* @property {string} options.tileHeight The height of each tile in pixels.
24-
* @property {Ellipsoid} [options.ellipsoid=Ellipsoid.default] The ellipsoid. If not specified, the default ellipsoid is used.
25-
* @property {number} [options.minimumLevel=0] The minimum level-of-detail supported by the imagery provider. Take care when specifying
18+
* @property {string} key The Google api key to send with tile requests.
19+
* @property {string} session The Google session token that tracks the current state of your map and viewport.
20+
* @property {string|Resource|IonResource} url The Google 2D maps endpoint.
21+
* @property {string} tileWidth The width of each tile in pixels.
22+
* @property {string} tileHeight The height of each tile in pixels.
23+
* @property {Ellipsoid} [ellipsoid=Ellipsoid.default] The ellipsoid. If not specified, the default ellipsoid is used.
24+
* @property {number} [minimumLevel=0] The minimum level-of-detail supported by the imagery provider. Take care when specifying
2625
* this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely
2726
* to result in rendering problems.
28-
* @property {number} [options.maximumLevel=22] The maximum level-of-detail supported by the imagery provider.
29-
* @property {Rectangle} [options.rectangle=Rectangle.MAX_VALUE] The rectangle, in radians, covered by the image.
27+
* @property {number} [maximumLevel=22] The maximum level-of-detail supported by the imagery provider.
28+
* @property {Rectangle} [rectangle=Rectangle.MAX_VALUE] The rectangle, in radians, covered by the image.
3029
*/
3130

3231
/**
@@ -36,7 +35,7 @@ const trailingSlashRegex = /\/$/;
3635
*
3736
*
3837
* Provides 2D image tiles from {@link https://developers.google.com/maps/documentation/tile/2d-tiles-overview|Google 2D Tiles}.
39-
*
38+
*
4039
* Google 2D Tiles can only be used with the Google geocoder.
4140
*
4241
* @alias Google2DImageryProvider
@@ -52,7 +51,7 @@ const trailingSlashRegex = /\/$/;
5251
* @example
5352
* // Use your own Google api key
5453
* Cesium.GoogleMaps.defaultApiKey = "your-api-key";
55-
*
54+
*
5655
* const googleTilesProvider = Cesium.Google2DImageryProvider.fromUrl({
5756
* mapType: "SATELLITE"
5857
* });

0 commit comments

Comments
 (0)