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

Add @todo api and describe ol.geom.Geometry funcs #2177

Merged
merged 1 commit into from Jul 9, 2014

Conversation

pagameba
Copy link
Member

@pagameba pagameba commented Jun 9, 2014

The clone(), getSimplifiedGeometry() and getType() methods are all
base class methods documented in subclasses. They should appear in
ol.geom.Geometry in the API docs as well.

@elemoine
Copy link
Member

elemoine commented Jun 9, 2014

I'd like that @tschaub and @ahocevar review this. Things I'm wondering:

  • with this can we remove the @todo api annotations in ol.geometry.SimpleGeometry and ol.geometry.GeometryCollection?
  • and will the exports work correctly?

@pagameba
Copy link
Member Author

pagameba commented Jun 9, 2014

Agreed. I think there may be some other problems too. For instance, applyTransform is defined in ol.geom.Geometry with @todo api and is inherited in ol.geom.SimpleGeometry with @inheritDoc but the documentation in ol.geom.SimpleGeometry does not show the method as inherited.

@pagameba
Copy link
Member Author

pagameba commented Jun 9, 2014

Actually now I see that inherited methods that are implemented in subclasses never get annotated as inherited, even though they inherit documentation.

@tschaub
Copy link
Member

tschaub commented Jul 6, 2014

@pagameba - can you update this to use @api (instead of @todo api)?

The `clone()`, `getSimplifiedGeometry()` and `getType()` methods are all
base class methods documented in subclasses.  They should appear in
ol.geom.Geometry in the API docs as well.
@pagameba
Copy link
Member Author

pagameba commented Jul 7, 2014

rebased and updated.

@pagameba
Copy link
Member Author

pagameba commented Jul 8, 2014

Any objections to getting this in?

@tschaub
Copy link
Member

tschaub commented Jul 9, 2014

Looks good to me to merge. We may need to address Eric's comments separately (making @inheritDoc copy parent doclet properties).

pagameba added a commit that referenced this pull request Jul 9, 2014
Add @todo api and describe ol.geom.Geometry funcs
@pagameba pagameba merged commit f1bdaed into openlayers:master Jul 9, 2014
@pagameba pagameba deleted the geometry-api branch July 9, 2014 11:23
@osechet
Copy link

osechet commented Nov 15, 2016

Hi,
sorry, I know this is an old issue but I would like to understand why the modifications made with this PR have been "cancelled" with commit 6134a8b. The methods are still defined in ol.geom.Geometry but they don't appear in the documentation.

@ahocevar
Copy link
Member

@osechet #clone() does show up in the docs for all geometry subclasses, and so does #getType(). #getSimplifiedGeometry() is now #simplify().

@osechet
Copy link

osechet commented Nov 15, 2016

@ahocevar Yes they appear in the subclasses but not in the ol.geom.Geometry class. This PR is about adding them in the doc of ol.geom.Geometry. It has been done than "cancelled" few months later. I'm sure there is a good reason. I just would like to know what is that reason.

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

Successfully merging this pull request may close these issues.

None yet

5 participants