Skip to content

Conversation

@marcjansen
Copy link
Member

This PR adds basic documentation to @api symbols of ol.geom*. This never ends...

Please review.

See also

Copy link
Member

Choose a reason for hiding this comment

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

This is something we'll probably have to deal with, but the builder client doesn't do any special parsing of JSDoc's custom @lnk style annotations. It would reduce work in the near-term to just have plain text for the first sentence (subtle, but the description for #3497 does specify plain text).

@tschaub
Copy link
Member

tschaub commented Apr 22, 2015

Nice @marcjansen. Since my comment above applies to a number of commits and also reflects an issue with current docs, I don't think you have to deal with it here. We can regex our way around the @link annotations in the build client.

@marcjansen
Copy link
Member Author

Cool, thanks, @tschaub.

marcjansen added a commit that referenced this pull request Apr 22, 2015
Add a one sentence summary for ol.geom.* exportable symbols
@marcjansen marcjansen merged commit 9d4db18 into openlayers:master Apr 22, 2015
@marcjansen marcjansen deleted the one-sentence-geom branch March 21, 2016 16:29
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.

2 participants