Skip to content
Permalink
Browse files
Overloads shouldn't gain @deprecated tags of other overloads in quick…
… info (#50904)

* Add test case to check for the propogation of @Deprecation tag to multiple overloads

* Implement filter to only include @deprecated tag in first signature after JSDoc comment
  • Loading branch information
ValerianClerc committed Oct 11, 2022
1 parent e14a229 commit 503604c884bd0557c851b11b699ef98cdb65b93b
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
@@ -725,8 +725,9 @@ namespace ts.SymbolDisplay {

if (allSignatures.length > 1 && documentation.length === 0 && tags.length === 0) {
documentation = allSignatures[0].getDocumentationComment(typeChecker);
tags = allSignatures[0].getJsDocTags();
tags = allSignatures[0].getJsDocTags().filter(tag => tag.name !== "deprecated"); // should only include @deprecated JSDoc tag on the first overload (#49368)
}

}

function writeTypeParametersOfSymbol(symbol: Symbol, enclosingDeclaration: Node | undefined) {
@@ -0,0 +1,26 @@
/// <reference path="fourslash.ts" />
// @target: esnext

// @Filename: /a.ts
/////**
//// * A function that gets the length of an array.
//// * @param testParam
//// * @deprecated Use the new method instead.
//// */
////export function getArrayLength(arr: string[]): number;
////export function getArrayLength(arr: boolean[]): number;

// @Filename: /b.ts
////import { getArrayLength } from "/a";
/////*1*/getArrayLength(["hello"]);
/////*2*/getArrayLength([true]);
/////*3*/getArrayLength(["hello"]);


goTo.file("/b.ts");
goTo.marker("1")
verify.quickInfoIs("(alias) getArrayLength(arr: string[]): number (+1 overload)\nimport getArrayLength", "A function that gets the length of an array.", [{name: "param", text: "testParam"}, {name: "deprecated", text: "Use the new method instead."}])
goTo.marker("2")
verify.quickInfoIs("(alias) getArrayLength(arr: boolean[]): number (+1 overload)\nimport getArrayLength", "A function that gets the length of an array.", [{name: "param", text: "testParam"}])
goTo.marker("3")
verify.quickInfoIs("(alias) getArrayLength(arr: string[]): number (+1 overload)\nimport getArrayLength", "A function that gets the length of an array.", [{name: "param", text: "testParam"}, {name: "deprecated", text: "Use the new method instead."}])

0 comments on commit 503604c

Please sign in to comment.