From cdd016f3b60dbfd1229a943229838751ecb74597 Mon Sep 17 00:00:00 2001 From: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com> Date: Wed, 9 Sep 2020 14:38:46 -0700 Subject: [PATCH 1/2] Add test --- tests/cases/fourslash/quickInfoJsDocTags.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/tests/cases/fourslash/quickInfoJsDocTags.ts b/tests/cases/fourslash/quickInfoJsDocTags.ts index 2d81cb23679d8..107277b53a4af 100644 --- a/tests/cases/fourslash/quickInfoJsDocTags.ts +++ b/tests/cases/fourslash/quickInfoJsDocTags.ts @@ -11,6 +11,7 @@ //// * @property {number} x The prop //// * @param {number} x The param //// * @returns The result +//// * @see x (the parameter) //// */ ////function /**/foo(x) {} From 63bca3aa0519590ec4cb9274deaa7d2bf7710335 Mon Sep 17 00:00:00 2001 From: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com> Date: Wed, 9 Sep 2020 14:45:28 -0700 Subject: [PATCH 2/2] Treat see tags same as param tags --- src/services/jsDoc.ts | 3 ++- tests/baselines/reference/quickInfoJsDocTags.baseline | 8 ++++++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/src/services/jsDoc.ts b/src/services/jsDoc.ts index 3115109572a0d..f011bac85956c 100644 --- a/src/services/jsDoc.ts +++ b/src/services/jsDoc.ts @@ -138,7 +138,8 @@ namespace ts.JsDoc { case SyntaxKind.JSDocCallbackTag: case SyntaxKind.JSDocPropertyTag: case SyntaxKind.JSDocParameterTag: - const { name } = tag as JSDocTypedefTag | JSDocPropertyTag | JSDocParameterTag; + case SyntaxKind.JSDocSeeTag: + const { name } = tag as JSDocTypedefTag | JSDocPropertyTag | JSDocParameterTag | JSDocSeeTag; return name ? withNode(name) : comment; default: return comment; diff --git a/tests/baselines/reference/quickInfoJsDocTags.baseline b/tests/baselines/reference/quickInfoJsDocTags.baseline index a146e8e18769c..5717757a38294 100644 --- a/tests/baselines/reference/quickInfoJsDocTags.baseline +++ b/tests/baselines/reference/quickInfoJsDocTags.baseline @@ -2,13 +2,13 @@ { "marker": { "fileName": "/tests/cases/fourslash/quickInfoJsDocTags.ts", - "position": 272 + "position": 298 }, "quickInfo": { "kind": "function", "kindModifiers": "", "textSpan": { - "start": 272, + "start": 298, "length": 3 }, "displayParts": [ @@ -99,6 +99,10 @@ { "name": "returns", "text": "The result" + }, + { + "name": "see", + "text": "x (the parameter)" } ] }