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

Document types for unexported symbols #1981

Closed

Conversation

ahocevar
Copy link
Member

With this change, we get documentation for the type of
ol.render.Event#vectorContext, and other types of unexported
symbols.

With this change, we get documentation for the type of
ol.render.Event#vectorContext, and other types of unexported
symbols.
@tschaub
Copy link
Member

tschaub commented Apr 11, 2014

@ahocevar shouldn't we instead be exporting properties like vectorContext if we want them used (and documented)?

@ahocevar
Copy link
Member Author

@tschaub You mean so we can get rid of externs/oli.js? Let me try if that works.

@ahocevar ahocevar closed this Apr 11, 2014
@ahocevar ahocevar deleted the document-params-for-unexported branch April 11, 2014 16:39
@tschaub
Copy link
Member

tschaub commented Apr 11, 2014

@ahocevar sorry, not sure it is actually possible. There has been discussion before about not being able to export prototype properties, and this is the whole reason for oli.js I guess. I'd need to dig a bit to get the complete picture.

@ahocevar
Copy link
Member Author

At least for ol.render.RenderEvent it works when marking context, vectorContext etc. as @todo api in the custom-build branch.

@ahocevar
Copy link
Member Author

Scratch that. oli.js is needed. However, I'm working on a better approach now, by making @interface a known JSDoc tag.

@ahocevar
Copy link
Member Author

d12c2ec, which is the better approach mentioned above, solves this issue on top of #1979.

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

2 participants