You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adding @api to ol.Sphere makes it appear in the API docs, and provides a link from ol.geom.Polygon#circular. As commented in #2359 this does not help with ol.Sphere.WGS84, but that problem can be handled separately.
Adding @api to ol.Sphere also fixes a problem in the externs file generated by the generate-externs.js task. Without the @api annotation the externs file includes references to the ol.Sphere, which is unknown.
this doesn't really close #2359, as there's still no docs on how to use Sphere, which was what that issue was mainly about. A simple workaround would be to add some docs with an example on how to use ol.sphere.WGS84 to ol.Sphere.
this doesn't really close #2359, as there's still no docs on how to use Sphere, which was what that issue was mainly about. A simple workaround would be to add some docs with an example to ol.Sphere.
Good call. I made other changes. The tissot example now uses the documented ol.Sphere class directly, as opposed to using the ol.sphere.WGS84 instance which is not in the documentation (as reported in #2359). So I also removed the @api annotation from ol.sphere.WGS84. This time I think this PR fully addresses #2359. Please review.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adding
@apitool.Spheremakes it appear in the API docs, and provides a link fromol.geom.Polygon#circular. As commented in #2359 this does not help withol.Sphere.WGS84, but that problem can be handled separately.Adding
@apitool.Spherealso fixes a problem in the externs file generated by thegenerate-externs.jstask. Without the@apiannotation the externs file includes references to theol.Sphere, which is unknown.Please review.