Support @throws tag #305
Merged
Support @throws tag #305
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
|
CLA is valid! |
| @@ -182,6 +182,7 @@ YUI.add('docparser', function (Y) { | |||
| 'augments': 'uses', // YUI convention for prototype mixins | |||
| 'depreciated': 'deprecated', // subtle difference | |||
| 'desciption': 'description', // shouldn't need the @description tag at all | |||
| 'exception': 'throws', // we may want standalone inner functions at some point | |||
There was a problem hiding this comment.
This comment doesn't make any sense. Copy/paste issue?
Closed
|
I'll merge this in the next week if I have no feedback this week. And I'm planning release the next version with this in the next week. /cc @juandopazo @caridy |
| @@ -191,7 +192,8 @@ YUI.add('docparser', function (Y) { | |||
| 'parma': 'param', // typo | |||
| 'propery': 'property', // typo | |||
| 'prop': 'property', // probably meant property | |||
| 'returns': 'return' // need to standardize on one or the other | |||
| 'returns': 'return', // need to standardize on one or the other | |||
| 'throw': 'throws' // need to standardize on one or the other | |||
There was a problem hiding this comment.
I don't think we need throw or exception unless users tell us it's a common mistake.
|
Updated for review from @juandopazo. |
|
LGTM! |
|
Thanks a lot. |
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.
It works similar with the
@returntag. This means that a type is optional. An actual example is like the following. And, this resolves #135 finally.This is a new feature, so I wish I could get any reviewers.
/cc @juandopazo @caridy