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

Use @classdesc notation #2183

Merged
merged 1 commit into from Jul 7, 2014
Merged

Use @classdesc notation #2183

merged 1 commit into from Jul 7, 2014

Conversation

pagameba
Copy link
Member

Add @classdesc to the remaining classes from #2178

@probins
Copy link
Contributor

probins commented Jun 10, 2014

thanks @pagameba - though I'm afraid that doesn't help me on when you would use these. :-( Perhaps what's needed is some examples.

Why is Travis failing here? Some unrelated issue?

@pagameba
Copy link
Member Author

I think that, with the exception of ol.render.canvas.Immediate, these are mostly internal classes that you would not normally interact with directly. And maybe WebGL, but that feature is not fully baked yet.

ol.render.canvas.Immediate does deserve more of a write up and its quite likely it will get used as part of the postcompose event. There are some examples (like the IGC one) which use this. I'll try to add an example today when I have a moment.

Looks like travis is failing because of a new jsdoc?

@@ -13,6 +13,9 @@ goog.require('ol.TileState');


/**
* @classdesc
* Load tiles as images.
Copy link
Member

Choose a reason for hiding this comment

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

This constructor is not part of the API anyway.

@pagameba
Copy link
Member Author

pagameba commented Jul 3, 2014

I beefed up the description of ol.render.canvas.Immediate a bit and removed the class description from the non-api ImageTile.

@probins
Copy link
Contributor

probins commented Jul 3, 2014

removed the class description from the non-api ImageTile.

http://ol3js.org/en/master/apidoc/ol.ImageTile.html

@tschaub
Copy link
Member

tschaub commented Jul 7, 2014

This looks good to merge.

pagameba added a commit that referenced this pull request Jul 7, 2014
@pagameba pagameba merged commit 570a0c2 into openlayers:master Jul 7, 2014
@pagameba pagameba deleted the classdesc branch July 7, 2014 12:30
@pagameba
Copy link
Member Author

pagameba commented Jul 7, 2014

Merged, Image Tile can be updated separately as required.

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

4 participants