mirror of
https://github.com/microsoft/TypeScript.git
synced 2026-02-05 16:38:05 -06:00
* Rename SyntaxKind.JSDocComment -> JSDoc Early on, I made the mistake of using the syntax kind JSDocComment for the type JSDoc. This arose because I hadn't decided on the terminology of "jsdoc" for the C-style comment that is attached to a declaration. "comment" for the text that follows a tag. By the time I settled on those terms consistently, a version had already shipped with `interface JSDoc` having `SyntaxKind.JSDocComment`. However, there is now a `type JSDocComment` that represents the possible contents of the comment text (strings and various kinds of `@link`), so it's doubly confusing that this type has a union of four kinds instead of SyntaxKind.JSDocComment. Although this is a public API break, I don't think it's hard to recover from, and the JSDoc API has accessors for individual tag types, so I suspect few people refer directly to SyntaxKind.JSDocComment. * Add deprecate JSDocComment alias to JSDoc For backward compatibility * Make JSDoc an alias of JSDocComment Improves output of JSDocParsing tests without having to make its code smarter. * update API baselines