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.

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

Documenting ol.Sphere #2359

Closed
probins opened this issue Jul 13, 2014 · 0 comments
Closed

Documenting ol.Sphere #2359

probins opened this issue Jul 13, 2014 · 0 comments
Milestone

Comments

@probins
Copy link
Contributor

probins commented Jul 13, 2014

As discussed in #2328 (comment) ol.Sphere is used in the Tissot example but doesn't appear in the docs, which aren't very helpful in this respect. Adding @api to ol.Sphere makes it appear in the docs, and provides a link from ol.geom.Polygon#circular, but this doesn't help with ol.Sphere.WGS84, which doesn't appear even though it is @api. This is because it isn't a subclass but an instance of ol.Sphere, defined in the tags as a @const. JSDoc doesn't know what to do with these.

As ol.Sphere.WGS84 (and ol.Sphere.NORMAL) simply provides a radius to ol.Sphere, I'm wondering if it wouldn't be better to have these radii stored in an enum or something rather than as separate symbols.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants