Fix bug: Include comment for @param tag with nested tag #23276
Conversation
ghost
requested a review
from 
| @@ -6526,6 +6526,8 @@ namespace ts { | |||
| const result = target === PropertyLikeParse.Parameter ? | |||
| <JSDocParameterTag>createNode(SyntaxKind.JSDocParameterTag, atToken.pos) : | |||
| <JSDocPropertyTag>createNode(SyntaxKind.JSDocPropertyTag, atToken.pos); | |||
| let comment: string | undefined; | |||
| if (indent !== undefined) comment = parseTagComments(indent + scanner.getStartPos() - atToken.pos); | |||
There was a problem hiding this comment.
If only nested @params were missing comments before this change, where was the comment parsed for non-nested ones? Does this change now parse the comments for all @params here?
There was a problem hiding this comment.
Yeah, previously it was always done at the bottom of parseTag. But that didn't work if the comment had already been skipped.
| parsesCorrectly("Nested @param tags", | ||
| `/** | ||
| * @param {object} o Doc doc | ||
| * @param {string} o.f |
There was a problem hiding this comment.
I thought it was the comments on nested @param that were incorrectly skipped. Shouldn’t this test include some comments for this line too?
There was a problem hiding this comment.
parseChildParameterOrPropertyTag begins by skipping a line. So it's the comment that comes before the child that was skipped. But I'll add some comments for that line too.
Fixes #23221 (comment)
parseChildParameterOrPropertyTagcontains code to skip ahead to the next line -- this means that the comment goes missing. We should probably never skip a comment, but that would be a bigger change than this.