Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Two small JSDoc/TS fixes #8928

Merged
merged 2 commits into from
Jun 8, 2020
Merged

Two small JSDoc/TS fixes #8928

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c97bcb
Two small JSDoc/TS fixes
mramato Jun 7, 2020
251ec6d
Update CHANGES.
mramato Jun 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,12 @@

##### Fixes :wrench:

- Improved `MaterialProperty` JSDoc and TypeScript type definitions, which were missing the ability to take primitive types in addition to Property instances in their constructor.
- Fixed `EllipsoidGeodesic` JSDoc and TypeScript type definitions which incorrectly listed `result` as required.
- Improved `MaterialProperty` JSDoc and TypeScript type definitions, which were missing the ability to take primitive types in addition to Property instances in their constructor. [#8904](https://github.com/CesiumGS/cesium/pull/8904)
- Fixed `EllipsoidGeodesic` JSDoc and TypeScript type definitions which incorrectly listed `result` as required. [#8904](https://github.com/CesiumGS/cesium/pull/8904)
- Fixed a bug with handling of PixelFormat's flipY. [#8893](https://github.com/CesiumGS/cesium/pull/8893)
- Fixed JSDoc and TypeScript type definitions for all `ImageryProvider` types, which were missing `defaultNightAlpha` and `defaultDayAlpha` properties.
- Fixed JSDoc and TypeScript type definitions for all `ImageryProvider` types, which were missing `defaultNightAlpha` and `defaultDayAlpha` properties. [#8908](https://github.com/CesiumGS/cesium/pull/8908)
- Fixed JSDoc and TypeScript type definitions for `EllipsoidTangentPlane.fromPoints`, which takes an array of `Cartesian3`, not a single instance. [#8928](https://github.com/CesiumGS/cesium/pull/8928)
- Fixed JSDoc and TypeScript type definitions for `EntityCollection.getById` and `CompositeEntityCollection.getById`, which can both return undefined. [#8928](https://github.com/CesiumGS/cesium/pull/8928)
Comment on lines -11 to +16
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These should all be moved under a new "1.70.1" patch release right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, everything currently in 1.71.0 will be part of 1.70.1, so everything can just stay here until we update the 1.71.0 header to take the release.

- Fixed JSDoc and TypeScript type definitions for `Viewer` options parameter, which was incorrectly listed as required.
- Fixed a memory leak where some 3D Tiles requests were being unintentionally retained after the requests were cancelled. [#8843](https://github.com/CesiumGS/cesium/pull/8843)

Expand Down
2 changes: 1 addition & 1 deletion Source/Core/EllipsoidTangentPlane.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ var tmp = new AxisAlignedBoundingBox();
* Creates a new instance from the provided ellipsoid and the center
* point of the provided Cartesians.
*
* @param {Cartesian3} cartesians The list of positions surrounding the center point.
* @param {Cartesian3[]} cartesians The list of positions surrounding the center point.
* @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid to use.
*/
EllipsoidTangentPlane.fromPoints = function (cartesians, ellipsoid) {
Expand Down
2 changes: 1 addition & 1 deletion Source/DataSources/CompositeEntityCollection.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -463,7 +463,7 @@ CompositeEntityCollection.prototype.computeAvailability = function () {
* Gets an entity with the specified id.
*
* @param {String} id The id of the entity to retrieve.
* @returns {Entity} The entity with the provided id or undefined if the id did not exist in the collection.
* @returns {Entity|undefined} The entity with the provided id or undefined if the id did not exist in the collection.
*/
CompositeEntityCollection.prototype.getById = function (id) {
return this._composite.getById(id);
Expand Down
2 changes: 1 addition & 1 deletion Source/DataSources/EntityCollection.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,7 @@ EntityCollection.prototype.removeAll = function () {
* Gets an entity with the specified id.
*
* @param {String} id The id of the entity to retrieve.
* @returns {Entity} The entity with the provided id or undefined if the id did not exist in the collection.
* @returns {Entity|undefined} The entity with the provided id or undefined if the id did not exist in the collection.
*/
EntityCollection.prototype.getById = function (id) {
//>>includeStart('debug', pragmas.debug);
Expand Down