Use @classdesc notation #2178
Merged
Use @classdesc notation #2178
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
+1 from me. Thanks a lot for the effort @probins! |
|
Just had a look, I think this is a very useful change. Great work! I think the |
|
I agree this is a great improvement. Thanks for the huge effort on it @probins! |
|
it would be good if someone could find time to add a desc for those I list above. I suspect these won't be used very much, but there's not much point having them in the api if people don't know what they're for :-) And I think there should be a rule: no additions to the api without some docs to describe them. |
see #2183 |
pagameba
added a commit
to pagameba/ol3
that referenced
this pull request
Jul 3, 2014
oterral
pushed a commit
to geoadmin/ol3
that referenced
this pull request
Nov 6, 2014
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Phew! When I offered to add
@classdescto classes https://groups.google.com/forum/#!topic/ol3-dev/7l9rQ6W5c7A I hadn't realised there were quite so many. 113 files updated, some using existing description, some new. Some of these are really stating the obvious, but can be changed later as needed.Some of the vector base sources I have left for now, while I work out how they fit together. And some others I have left, as I don't know what they are for or when you would use them. These are:
I added the word 'abstract' to those I consider to be abstract base classes, not usually instantiated in apps. jsdoc does process the
@abstracttag, but there are issues with this at the moment. In any case, I think these should be differentiated in the html somehow. I'll raise a topic on the list for this.There's a generated output at http://probins.github.io/classdesc/apidoc/