This repository has been archived by the owner on Dec 15, 2022. It is now read-only.
Allow multiple types to be specified in JSDoc tags #418
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
|
The documentation also says that the types have to be surrounded by parentheses: |
|
I'll add support for the bracket-notation, but I should mention the notation doesn't appear to be mandatory. Running /**
* Insert snarky name here.
*
* Add dry-witted description here.
*
* @param {Number|Function} callable - Something to return
* @return {String|Object} Something
*/
function test(callable){
return "ffs";
}Result:
Also, there's a lot of code in the wild that omits the brackets. E.g., this. |
|
There was a brief discussion about this here: jsdoc/jsdoc#1104 The TL;DR-version is that both ways are accepted. |
|
Okay, fixed. |
| @@ -1701,7 +1701,7 @@ | |||
| 'match': '''(?x) | |||
| (?:(?<=@returns)|(?<=@return)) | |||
| \\s+ | |||
| ({(?:\\*|(?:\\?|\\!|\\.{3})?[a-zA-Z_$][\\w$]*(?:\\.[a-zA-Z_$][\\w$]*)*(?:\\[\\])?=?)}) | |||
| ({(?:\\*|(?:\\?|\\!|\\.{3})?[a-zA-Z_$][\\w$]*(?:[\\.|][a-zA-Z_$][\\w$]*)*(?:\\[\\])?=?)}) | |||
There was a problem hiding this comment.
What about parentheses here?
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
JSDoc allows more than one type to be specified in a
@typetag or whatever:This PR fixes that.