@description JSDoc tag interferes with callback parameter documentation #37346
Labels
Bug
A bug in TypeScript
checkJs
Relates to checking JavaScript using TypeScript
Help Wanted
You can do this
PursuitFellowship
Help wanted from Pursuit fellowship; others please avoid until Dec 19
Milestone
TypeScript Version: 3.8.3
Search Terms: jsdoc param
Expected behavior:
Below code creates no errors, type of
x
is recognized as(value: number) => boolean
Actual behavior:
Type of
x
is() => boolean
, the invocation creates a type error.Removing the
@description
tag makes the code work as expected.My interpretation of https://jsdoc.app/tags-description.html is that you should be able to place
@description
anywhere in the comment without interfering with other tags:Related Issues: Ran into a crash #37265 while trying to repro this with template parameters.
Code
Compiler Options
Playground Link: Provided
The text was updated successfully, but these errors were encountered: