Fix bug: Don't let empty signature documentation override other documentation (microsoft#26638)

Author: Andy

src/services/symbolDisplay.ts

@@ -611,7 +611,8 @@ namespace ts.SymbolDisplay {
                 displayParts.push(textPart(allSignatures.length === 2 ? "overload" : "overloads"));
                 displayParts.push(punctuationPart(SyntaxKind.CloseParenToken));
             }
-            documentation = signature.getDocumentationComment(typeChecker);
+            const docComment = signature.getDocumentationComment(typeChecker);
+            documentation = docComment.length === 0 ? undefined : docComment;
             tags = signature.getJsDocTags();
         }
 

tests/cases/fourslash/commentsClass.ts

@@ -1,6 +1,6 @@
 /// <reference path='fourslash.ts' />
 
-/////** This is class c2 without constuctor*/
+/////** This is class c2 without constructor*/
 ////class c/*1*/2 {
 ////}
 ////var i/*2*/2 = new c/*28*/2(/*3*/);
@@ -59,15 +59,15 @@
 ////var myVar = new m.m2.c/*33*/1();
 
 verify.quickInfos({
-    1: ["class c2", "This is class c2 without constuctor"],
+    1: ["class c2", "This is class c2 without constructor"],
     2: "var i2: c2"
 });
 
 verify.signatureHelp({ marker: "3", docComment: "" });
 
 verify.quickInfos({
     4: "var i2_c: typeof c2",
-    5: ["class c2", "This is class c2 without constuctor"],
+    5: ["class c2", "This is class c2 without constructor"],
     6: "class c3",
     7: "var i3: c3"
 });
@@ -107,7 +107,7 @@ verify.quickInfos({
 });
 
 goTo.marker('26');
-verify.completionListContains("c2", "class c2", "This is class c2 without constuctor");
+verify.completionListContains("c2", "class c2", "This is class c2 without constructor");
 verify.completionListContains("i2", "var i2: c2", "");
 verify.completionListContains("i2_c", "var i2_c: typeof c2", "");
 verify.completionListContains("c3", "class c3", "");
@@ -131,10 +131,10 @@ verify.signatureHelp({
 });
 
 verify.quickInfos({
-    28: "constructor c2(): c2",
+    28: ["constructor c2(): c2", "This is class c2 without constructor"],
     29: ["constructor c3(): c3", "Constructor comment"],
     30: ["constructor c4(): c4", "Constructor comment"],
-    31: "constructor c5(): c5",
+    31: ["constructor c5(): c5", "Class with statics"],
     32: ["constructor c6(): c6", "constructor comment"],
     33: ["constructor m.m2.c1(): m.m2.c1", "constructor comment"]
 });

tests/cases/fourslash/commentsCommentParsing.ts

@@ -323,7 +323,7 @@ verify.quickInfos({
 
 verify.signatureHelp({ marker: "26", overloadsCount: 2, docComment: "" });
 verify.quickInfos({
-    "26q": "function f1(b: string): any (+1 overload)",
+    "26q": ["function f1(b: string): any (+1 overload)", "fn f1 with number"],
     "26aq": "(parameter) b: string"
 });
 

tests/cases/fourslash/commentsExternalModules.ts

@@ -55,7 +55,7 @@ verify.quickInfoAt("6q", "function m1.fooExport(): number", "exported function")
 verify.quickInfoAt("7", "var myvar: m1.m2.c");
 
 goTo.marker('8');
-verify.completionListContains("c", "constructor m1.m2.c(): m1.m2.c", "");
+verify.completionListContains("c", "constructor m1.m2.c(): m1.m2.c", "class comment;");
 verify.completionListContains("i", "var m1.m2.i: m1.m2.c", "i");
 
 goTo.file("commentsExternalModules_file1.ts");
@@ -78,5 +78,5 @@ verify.quickInfoAt("13q", "function extMod.m1.fooExport(): number", "exported fu
 verify.quickInfoAt("14", "var newVar: extMod.m1.m2.c");
 
 goTo.marker('15');
-verify.completionListContains("c", "constructor extMod.m1.m2.c(): extMod.m1.m2.c", "");
+verify.completionListContains("c", "constructor extMod.m1.m2.c(): extMod.m1.m2.c", "class comment;");
 verify.completionListContains("i", "var extMod.m1.m2.i: extMod.m1.m2.c", "i");

tests/cases/fourslash/commentsImportDeclaration.ts

@@ -49,7 +49,7 @@ verify.quickInfos({
 verify.completions({
     marker: "10",
     exact:  [
-        { name: "c", text: "constructor extMod.m1.m2.c(): extMod.m1.m2.c" },
+        { name: "c", text: "constructor extMod.m1.m2.c(): extMod.m1.m2.c", documentation: "class comment;" },
         { name: "i", text: "var extMod.m1.m2.i: extMod.m1.m2.c", documentation: "i" },
     ],
 });

tests/cases/fourslash/commentsInheritance.ts

@@ -223,7 +223,7 @@
 goTo.marker('1');
 verify.completionListContains("i1_p1", "(property) i1.i1_p1: number", "i1_p1");
 verify.completionListContains("i1_f1", "(method) i1.i1_f1(): void", "i1_f1");
-verify.completionListContains("i1_l1", "(property) i1.i1_l1: () => void", "");
+verify.completionListContains("i1_l1", "(property) i1.i1_l1: () => void", "i1_l1");
 verify.completionListContains("i1_nc_p1", "(property) i1.i1_nc_p1: number", "");
 verify.completionListContains("i1_nc_f1", "(method) i1.i1_nc_f1(): void", "");
 verify.completionListContains("i1_nc_l1", "(property) i1.i1_nc_l1: () => void", "");
@@ -244,7 +244,7 @@ verify.quickInfos({
     "3q": "(method) i1.i1_nc_f1(): void",
     "4q": "(method) i1.f1(): void",
     "5q": "(method) i1.nc_f1(): void",
-    l2q: "(property) i1.i1_l1: () => void",
+    l2q: ["(property) i1.i1_l1: () => void", "i1_l1"],
     l3q: "(property) i1.i1_nc_l1: () => void",
     l4q: "(property) i1.l1: () => void",
     l5q: "(property) i1.nc_l1: () => void"
@@ -253,7 +253,7 @@ verify.quickInfos({
 goTo.marker('6');
 verify.completionListContains("i1_p1", "(property) c1.i1_p1: number", "i1_p1");
 verify.completionListContains("i1_f1", "(method) c1.i1_f1(): void", "i1_f1");
-verify.completionListContains("i1_l1", "(property) c1.i1_l1: () => void", "");
+verify.completionListContains("i1_l1", "(property) c1.i1_l1: () => void", "i1_l1");
 verify.completionListContains("i1_nc_p1", "(property) c1.i1_nc_p1: number", "");
 verify.completionListContains("i1_nc_f1", "(method) c1.i1_nc_f1(): void", "");
 verify.completionListContains("i1_nc_l1", "(property) c1.i1_nc_l1: () => void", "");
@@ -278,7 +278,7 @@ verify.quickInfos({
     "8q": "(method) c1.i1_nc_f1(): void",
     "9q": ["(method) c1.f1(): void", "c1_f1"],
     "10q": ["(method) c1.nc_f1(): void", "c1_nc_f1"],
-    l7q: "(property) c1.i1_l1: () => void",
+    l7q: ["(property) c1.i1_l1: () => void", "i1_l1"],
     l8q: "(property) c1.i1_nc_l1: () => void",
     l9q: ["(property) c1.l1: () => void", "c1_l1"],
     l10q: ["(property) c1.nc_l1: () => void", "c1_nc_l1"],
@@ -287,7 +287,7 @@ verify.quickInfos({
 goTo.marker('11');
 verify.completionListContains("i1_p1", "(property) i1.i1_p1: number", "i1_p1");
 verify.completionListContains("i1_f1", "(method) i1.i1_f1(): void", "i1_f1");
-verify.completionListContains("i1_l1", "(property) i1.i1_l1: () => void", "");
+verify.completionListContains("i1_l1", "(property) i1.i1_l1: () => void", "i1_l1");
 verify.completionListContains("i1_nc_p1", "(property) i1.i1_nc_p1: number", "");
 verify.completionListContains("i1_nc_f1", "(method) i1.i1_nc_f1(): void", "");
 verify.completionListContains("i1_nc_l1", "(property) i1.i1_nc_l1: () => void", "");
@@ -307,7 +307,7 @@ verify.quickInfos({
     "13q": "(method) i1.i1_nc_f1(): void",
     "14q": "(method) i1.f1(): void",
     "15q": "(method) i1.nc_f1(): void",
-    l12q: "(property) i1.i1_l1: () => void",
+    l12q: ["(property) i1.i1_l1: () => void", "i1_l1"],
     l13q: "(property) i1.i1_nc_l1: () => void",
     l14q: "(property) i1.l1: () => void",
     l15q: "(property) i1.nc_l1: () => void",
@@ -437,13 +437,13 @@ verify.completionListContains("c4_i", "var c4_i: c4", "");
 goTo.marker('36');
 verify.completionListContains("i2_p1", "(property) i2.i2_p1: number", "i2_p1");
 verify.completionListContains("i2_f1", "(method) i2.i2_f1(): void", "i2_f1");
-verify.completionListContains("i2_l1", "(property) i2.i2_l1: () => void", "");
+verify.completionListContains("i2_l1", "(property) i2.i2_l1: () => void", "i2_l1");
 verify.completionListContains("i2_nc_p1", "(property) i2.i2_nc_p1: number", "");
 verify.completionListContains("i2_nc_f1", "(method) i2.i2_nc_f1(): void", "");
 verify.completionListContains("i2_nc_l1", "(property) i2.i2_nc_l1: () => void", "");
 verify.completionListContains("p1", "(property) i2.p1: number", "i2 p1");
 verify.completionListContains("f1", "(method) i2.f1(): void", "i2 f1");
-verify.completionListContains("l1", "(property) i2.l1: () => void", "");
+verify.completionListContains("l1", "(property) i2.l1: () => void", "i2 l1");
 verify.completionListContains("nc_p1", "(property) i2.nc_p1: number", "");
 verify.completionListContains("nc_f1", "(method) i2.nc_f1(): void", "");
 verify.completionListContains("nc_l1", "(property) i2.nc_l1: () => void", "");
@@ -460,22 +460,22 @@ verify.quickInfos({
     "38q": "(method) i2.i2_nc_f1(): void",
     "39q": ["(method) i2.f1(): void", "i2 f1"],
     "40q": "(method) i2.nc_f1(): void",
-    "l37q": "(property) i2.i2_l1: () => void",
+    "l37q": ["(property) i2.i2_l1: () => void", "i2_l1"],
     "l38q": "(property) i2.i2_nc_l1: () => void",
-    "l39q": "(property) i2.l1: () => void",
+    "l39q": ["(property) i2.l1: () => void", "i2 l1"],
     "l40q": "(property) i2.nc_l1: () => void",
 });
 
 goTo.marker('41');
 verify.completionListContains("i2_p1", "(property) i2.i2_p1: number", "i2_p1");
 verify.completionListContains("i2_f1", "(method) i2.i2_f1(): void", "i2_f1");
-verify.completionListContains("i2_l1", "(property) i2.i2_l1: () => void", "");
+verify.completionListContains("i2_l1", "(property) i2.i2_l1: () => void", "i2_l1");
 verify.completionListContains("i2_nc_p1", "(property) i2.i2_nc_p1: number", "");
 verify.completionListContains("i2_nc_f1", "(method) i2.i2_nc_f1(): void", "");
 verify.completionListContains("i2_nc_l1", "(property) i2.i2_nc_l1: () => void", "");
 verify.completionListContains("p1", "(property) i3.p1: number", "i3 p1");
 verify.completionListContains("f1", "(method) i3.f1(): void", "i3 f1");
-verify.completionListContains("l1", "(property) i3.l1: () => void", "");
+verify.completionListContains("l1", "(property) i3.l1: () => void", "i3 l1");
 verify.completionListContains("nc_p1", "(property) i3.nc_p1: number", "");
 verify.completionListContains("nc_f1", "(method) i3.nc_f1(): void", "");
 verify.completionListContains("nc_l1", "(property) i3.nc_l1: () => void", "");
@@ -490,22 +490,22 @@ verify.quickInfos({
     "43q": "(method) i2.i2_nc_f1(): void",
     "44q": ["(method) i3.f1(): void", "i3 f1"],
     "45q": "(method) i3.nc_f1(): void",
-    l42q: "(property) i2.i2_l1: () => void",
+    l42q: ["(property) i2.i2_l1: () => void", "i2_l1"],
     l43q: "(property) i2.i2_nc_l1: () => void",
-    l44q: "(property) i3.l1: () => void",
+    l44q: ["(property) i3.l1: () => void", "i3 l1"],
     l45q: "(property) i3.nc_l1: () => void"
 });
 
 goTo.marker('46');
 verify.completionListContains("i2_p1", "(property) i2.i2_p1: number", "i2_p1");
 verify.completionListContains("i2_f1", "(method) i2.i2_f1(): void", "i2_f1");
-verify.completionListContains("i2_l1", "(property) i2.i2_l1: () => void", "");
+verify.completionListContains("i2_l1", "(property) i2.i2_l1: () => void", "i2_l1");
 verify.completionListContains("i2_nc_p1", "(property) i2.i2_nc_p1: number", "");
 verify.completionListContains("i2_nc_f1", "(method) i2.i2_nc_f1(): void", "");
 verify.completionListContains("i2_nc_l1", "(property) i2.i2_nc_l1: () => void", "");
 verify.completionListContains("p1", "(property) i2.p1: number", "i2 p1");
 verify.completionListContains("f1", "(method) i2.f1(): void", "i2 f1");
-verify.completionListContains("l1", "(property) i2.l1: () => void", "");
+verify.completionListContains("l1", "(property) i2.l1: () => void", "i2 l1");
 verify.completionListContains("nc_p1", "(property) i2.nc_p1: number", "");
 verify.completionListContains("nc_f1", "(method) i2.nc_f1(): void", "");
 verify.completionListContains("nc_l1", "(property) i2.nc_l1: () => void", "");
@@ -520,9 +520,9 @@ verify.quickInfos({
     "48q": "(method) i2.i2_nc_f1(): void",
     "49q": ["(method) i2.f1(): void", "i2 f1"],
     "50q": "(method) i2.nc_f1(): void",
-    l47q: "(property) i2.i2_l1: () => void",
+    l47q: ["(property) i2.i2_l1: () => void", "i2_l1"],
     l48q: "(property) i2.i2_nc_l1: () => void",
-    l49q: "(property) i2.l1: () => void",
+    l49q: ["(property) i2.l1: () => void", "i2 l1"],
     l40q: "(property) i2.nc_l1: () => void"
 });
 
@@ -537,7 +537,7 @@ verify.completionListContains("i2", "interface i2", "");
 verify.completionListContains("i3", "interface i3", "");
 
 verify.quickInfos({
-    52: "constructor c5(): c5",
+    52: ["constructor c5(): c5", "c5 class"],
     53: ["class c5", "c5 class"],
     54: "(property) c5.b: number",
     55: ["constructor c2(a: number): c2", "c2 constructor"],

tests/cases/fourslash/commentsInterface.ts

@@ -96,7 +96,7 @@ verify.quickInfos({
 verify.signatureHelp({ marker: "12", docComment: "", parameterDocComment: "param help" });
 
 verify.quickInfos({
-    "12q": "(property) i2.foo: (b: number) => string",
+    "12q": ["(property) i2.foo: (b: number) => string", "this is foo"],
 
     13: "var i2_i_i2_si: number",
     "13q": "var i2_i: i2",
@@ -186,7 +186,7 @@ verify.completionListContains("i3_i", "var i3_i: i3", "");
 goTo.marker('41');
 verify.quickInfoIs("(method) i3.f(a: number): string", "Function i3 f");
 verify.completionListContains("f", "(method) i3.f(a: number): string", "Function i3 f");
-verify.completionListContains("l", "(property) i3.l: (b: number) => string", "");
+verify.completionListContains("l", "(property) i3.l: (b: number) => string", "i3 l");
 verify.completionListContains("x", "(property) i3.x: number", "Comment i3 x");
 verify.completionListContains("nc_f", "(method) i3.nc_f(a: number): string", "");
 verify.completionListContains("nc_l", "(property) i3.nc_l: (b: number) => string", "");
@@ -195,7 +195,7 @@ verify.completionListContains("nc_x", "(property) i3.nc_x: number", "");
 verify.signatureHelp({ marker: "42", docComment: "Function i3 f", parameterDocComment: "number parameter" });
 
 verify.signatureHelp({ marker: "43", docComment: "", parameterDocComment: "comment i3 l b" });
-verify.quickInfoAt("43q", "(property) i3.l: (b: number) => string");
+verify.quickInfoAt("43q", "(property) i3.l: (b: number) => string", "i3 l");
 
 verify.signatureHelp({ marker: "44", docComment: "" });
 verify.quickInfoAt("44q", "(method) i3.nc_f(a: number): string");

tests/cases/fourslash/commentsModules.ts

@@ -119,8 +119,8 @@ verify.signatureHelp({ marker: "6", docComment: "exported function" });
 verify.quickInfoAt("7", "var myvar: m1.m2.c");
 
 goTo.marker('8');
-verify.quickInfoIs("constructor m1.m2.c(): m1.m2.c");
-verify.completionListContains("c", "constructor m1.m2.c(): m1.m2.c", "");
+verify.quickInfoIs("constructor m1.m2.c(): m1.m2.c", "class comment;");
+verify.completionListContains("c", "constructor m1.m2.c(): m1.m2.c", "class comment;");
 verify.completionListContains("i", "var m1.m2.i: m1.m2.c", "i");
 
 goTo.marker('9');
@@ -132,8 +132,8 @@ verify.completionListContains("m3", "namespace m2.m3");
 verify.quickInfoIs("namespace m2.m3", "namespace comment of m2.m3");
 
 goTo.marker('11');
-verify.quickInfoIs("constructor m2.m3.c(): m2.m3.c");
-verify.completionListContains("c", "constructor m2.m3.c(): m2.m3.c", "");
+verify.quickInfoIs("constructor m2.m3.c(): m2.m3.c", "Exported class comment");
+verify.completionListContains("c", "constructor m2.m3.c(): m2.m3.c", "Exported class comment");
 
 goTo.marker('12');
 verify.completionListContains("m3", "namespace m3", "namespace comment of m3.m4.m5");
@@ -148,8 +148,8 @@ verify.completionListContains("m5", "namespace m3.m4.m5");
 verify.quickInfoIs("namespace m3.m4.m5", "namespace comment of m3.m4.m5");
 
 goTo.marker('15');
-verify.quickInfoIs("constructor m3.m4.m5.c(): m3.m4.m5.c");
-verify.completionListContains("c", "constructor m3.m4.m5.c(): m3.m4.m5.c", "");
+verify.quickInfoIs("constructor m3.m4.m5.c(): m3.m4.m5.c", "Exported class comment");
+verify.completionListContains("c", "constructor m3.m4.m5.c(): m3.m4.m5.c", "Exported class comment");
 
 goTo.marker('16');
 verify.completionListContains("m4", "namespace m4", "namespace comment of m4.m5.m6");
@@ -168,8 +168,8 @@ verify.completionListContains("m7", "namespace m4.m5.m6.m7");
 verify.quickInfoIs("namespace m4.m5.m6.m7");
 
 goTo.marker('20');
-verify.completionListContains("c", "constructor m4.m5.m6.m7.c(): m4.m5.m6.m7.c", "");
-verify.quickInfoIs("constructor m4.m5.m6.m7.c(): m4.m5.m6.m7.c");
+verify.completionListContains("c", "constructor m4.m5.m6.m7.c(): m4.m5.m6.m7.c", "Exported class comment");
+verify.quickInfoIs("constructor m4.m5.m6.m7.c(): m4.m5.m6.m7.c", "Exported class comment");
 
 goTo.marker('21');
 verify.completionListContains("m5", "namespace m5");
@@ -188,8 +188,8 @@ verify.completionListContains("m8", "namespace m5.m6.m7.m8");
 verify.quickInfoIs("namespace m5.m6.m7.m8", "namespace m8 comment");
 
 goTo.marker('25');
-verify.completionListContains("c", "constructor m5.m6.m7.m8.c(): m5.m6.m7.m8.c", "");
-verify.quickInfoIs("constructor m5.m6.m7.m8.c(): m5.m6.m7.m8.c");
+verify.completionListContains("c", "constructor m5.m6.m7.m8.c(): m5.m6.m7.m8.c", "Exported class comment");
+verify.quickInfoIs("constructor m5.m6.m7.m8.c(): m5.m6.m7.m8.c", "Exported class comment");
 
 goTo.marker('26');
 verify.completionListContains("m6", "namespace m6");
@@ -204,8 +204,8 @@ verify.completionListContains("m8", "namespace m6.m7.m8");
 verify.quickInfoIs("namespace m6.m7.m8");
 
 goTo.marker('29');
-verify.completionListContains("c", "constructor m6.m7.m8.c(): m6.m7.m8.c", "");
-verify.quickInfoIs("constructor m6.m7.m8.c(): m6.m7.m8.c");
+verify.completionListContains("c", "constructor m6.m7.m8.c(): m6.m7.m8.c", "Exported class comment");
+verify.quickInfoIs("constructor m6.m7.m8.c(): m6.m7.m8.c", "Exported class comment");
 
 goTo.marker('30');
 verify.completionListContains("m7", "namespace m7");
@@ -220,8 +220,8 @@ verify.completionListContains("m9", "namespace m7.m8.m9");
 verify.quickInfoIs("namespace m7.m8.m9", "namespace m9 comment");
 
 goTo.marker('33');
-verify.completionListContains("c", "constructor m7.m8.m9.c(): m7.m8.m9.c", "");
-verify.quickInfoIs("constructor m7.m8.m9.c(): m7.m8.m9.c");
+verify.completionListContains("c", "constructor m7.m8.m9.c(): m7.m8.m9.c", "Exported class comment");
+verify.quickInfoIs("constructor m7.m8.m9.c(): m7.m8.m9.c", "Exported class comment");
 
 goTo.marker('34');
 verify.completionListContains("c", 'class c', "");