@typedef supports nested @property names just like @param does
#22967
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
Previously it did not, because this capability is not documented on usejsdoc.org. However, several people requested this feature.
mhegazy
approved these changes
Mar 28, 2018
ghost
reviewed
Mar 29, 2018
| children = append(children, child); | ||
| let children: JSDocPropertyLikeTag[]; | ||
| while (child = tryParse(() => parseChildParameterOrPropertyTag(target, name))) { | ||
| if (child.kind === SyntaxKind.JSDocParameterTag || child.kind === SyntaxKind.JSDocPropertyTag) { |
There was a problem hiding this comment.
If we parsed an unexpected child we just drop it?
There was a problem hiding this comment.
The alternative that I thought was to break here, but it seems worse to pop up a level and start ignoring the prefixes the way we did before this PR.
(You can see an example at the end of the test I added.)
This is consistent with our treatment of jsdoc elsewhere, although perhaps we should have an error like "@type in the middle of a nested @typedef property". I don't think this mistake will happen that often though.
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.
Previously it did not, because this capability is not documented on usejsdoc.org. However, several people requested this feature.
Now properly produces the type
{ name: string, icons: { image32: string, image64: string } }.Fixes #20078