Microsoft/TypeScript
1
0
Fork 0
mirror of https://github.com/microsoft/TypeScript.git synced 2025-11-18 17:21:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix double asterisk formatting in JSDoc

Browse Source
This commit is contained in:
Armando Aguirre
2021-01-14 21:50:22 -08:00
parent c83f769850
commit 995023c2a7
2 changed files with 110 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/compiler/parser.ts
+9 -2
View File
@@ -7602,8 +7602,15 @@ namespace ts {
if (state === JSDocState.BeginningOfLine) {
// leading asterisks start recording on the *next* (non-whitespace) token
state = JSDocState.SawAsterisk;
indent += 1;
break;
if (lookAhead(() => nextTokenJSDoc() === SyntaxKind.AsteriskToken)) {
pushComment(scanner.getTokenText());
tok = nextTokenJSDoc();
}
else {
indent += 1;
break;
}
}
// record the * as a comment
// falls through
tests/cases/fourslash/quickInfoJsDocTextFormatting1.ts
+101
View File
@@ -0,0 +1,101 @@
/// <reference path='fourslash.ts'/>
// Regression test for #33386
//// /**
//// * @param {number} var1 **Highlighted text**
//// * @param {string} var2 Another **Highlighted text**
//// */
//// function f1(var1, var2) { }
////
//// /**
//// * @param {number} var1 *This asterisk gets trimmed unfortunatelly
//// * @param {string} var2 Another *Regular text with an asterisk
//// */
//// function f2(var1, var2) { }
////
//// /**
//// * @param {number} var1
//// * *Regular text with an asterisk
//// * @param {string} var2
//// * Another *Regular text with an asterisk
//// */
//// function f3(var1, var2) { }
////
//// /**
//// * @param {number} var1
//// * **Highlighted text**
//// * @param {string} var2
//// * Another **Highlighted text**
//// */
//// function f4(var1, var2) { }
////
//// /**
//// * @param {number} var1
//// **Highlighted text**
//// * @param {string} var2
//// Another **Highlighted text**
//// */
//// function f5(var1, var2) { }
////
//// f1(/*1*/);
//// f2(/*2*/);
//// f3(/*3*/);
//// f4(/*4*/);
//// f5(/*5*/);
verify.signatureHelp({
marker: "1",
parameterDocComment: "**Highlighted text**",
tags: [{
name: "param",
text: "var1 **Highlighted text**"
}, {
name: "param",
text: "var2 Another **Highlighted text**"
}]
});
verify.signatureHelp({
marker: "2",
parameterDocComment: "This asterisk gets trimmed unfortunatelly",
tags: [{
name: "param",
text: "var1 This asterisk gets trimmed unfortunatelly"
}, {
name: "param",
text: "var2 Another *Regular text with an asterisk"
}]
});
verify.signatureHelp({
marker: "3",
parameterDocComment: "*Regular text with an asterisk",
tags: [{
name: "param",
text: "var1 *Regular text with an asterisk"
}, {
name: "param",
text: "var2 Another *Regular text with an asterisk"
}]
});
verify.signatureHelp({
marker: "4",
parameterDocComment: "**Highlighted text**",
tags: [{
name: "param",
text: "var1 **Highlighted text**"
}, {
name: "param",
text: "var2 Another **Highlighted text**"
}]
});
verify.signatureHelp({
marker: "5",
parameterDocComment: "**Highlighted text**",
tags: [{
name: "param",
text: "var1 **Highlighted text**"
}, {
name: "param",
text: "var2 Another **Highlighted text**"
}]
});