a354a77030
* feat(services): jsdoc use custom name for display parts * fix(services): jsdoc typo * feat(services): revert jsDoc changes * feat(services): jsdoc improve displayparts with more comment kinds Improve rendering of JSDoc comment text with displayparts for: - `@typedef` - `@callback` - `@param` - `@property` * feat(services): jsdoc improve displayparts for template * test: accept baseline * test: update jsdoc parameterName * feat: resolve pr comments * test: add fourslash tests for jsdoc callback, typedef * test: accept baselines * test: revert changes for api baselines * refactor: naming * refactor: code quality * refactor: clean up code as to pr comments
442 lines
9.5 KiB
Plaintext
442 lines
9.5 KiB
Plaintext
[
|
|
{
|
|
"marker": {
|
|
"fileName": "/tests/cases/fourslash/signatureHelpCommentsClass.ts",
|
|
"position": 72,
|
|
"name": "3"
|
|
},
|
|
"signatureHelp": {
|
|
"items": [
|
|
{
|
|
"isVariadic": false,
|
|
"prefixDisplayParts": [
|
|
{
|
|
"text": "c2",
|
|
"kind": "className"
|
|
},
|
|
{
|
|
"text": "(",
|
|
"kind": "punctuation"
|
|
}
|
|
],
|
|
"suffixDisplayParts": [
|
|
{
|
|
"text": ")",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": ":",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": " ",
|
|
"kind": "space"
|
|
},
|
|
{
|
|
"text": "c2",
|
|
"kind": "className"
|
|
}
|
|
],
|
|
"separatorDisplayParts": [
|
|
{
|
|
"text": ",",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": " ",
|
|
"kind": "space"
|
|
}
|
|
],
|
|
"parameters": [],
|
|
"documentation": [],
|
|
"tags": []
|
|
}
|
|
],
|
|
"applicableSpan": {
|
|
"start": 72,
|
|
"length": 0
|
|
},
|
|
"selectedItemIndex": 0,
|
|
"argumentIndex": 0,
|
|
"argumentCount": 0
|
|
}
|
|
},
|
|
{
|
|
"marker": {
|
|
"fileName": "/tests/cases/fourslash/signatureHelpCommentsClass.ts",
|
|
"position": 175,
|
|
"name": "8"
|
|
},
|
|
"signatureHelp": {
|
|
"items": [
|
|
{
|
|
"isVariadic": false,
|
|
"prefixDisplayParts": [
|
|
{
|
|
"text": "c3",
|
|
"kind": "className"
|
|
},
|
|
{
|
|
"text": "(",
|
|
"kind": "punctuation"
|
|
}
|
|
],
|
|
"suffixDisplayParts": [
|
|
{
|
|
"text": ")",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": ":",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": " ",
|
|
"kind": "space"
|
|
},
|
|
{
|
|
"text": "c3",
|
|
"kind": "className"
|
|
}
|
|
],
|
|
"separatorDisplayParts": [
|
|
{
|
|
"text": ",",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": " ",
|
|
"kind": "space"
|
|
}
|
|
],
|
|
"parameters": [],
|
|
"documentation": [
|
|
{
|
|
"text": "Constructor comment",
|
|
"kind": "text"
|
|
}
|
|
],
|
|
"tags": []
|
|
}
|
|
],
|
|
"applicableSpan": {
|
|
"start": 175,
|
|
"length": 0
|
|
},
|
|
"selectedItemIndex": 0,
|
|
"argumentIndex": 0,
|
|
"argumentCount": 0
|
|
}
|
|
},
|
|
{
|
|
"marker": {
|
|
"fileName": "/tests/cases/fourslash/signatureHelpCommentsClass.ts",
|
|
"position": 298,
|
|
"name": "13"
|
|
},
|
|
"signatureHelp": {
|
|
"items": [
|
|
{
|
|
"isVariadic": false,
|
|
"prefixDisplayParts": [
|
|
{
|
|
"text": "c4",
|
|
"kind": "className"
|
|
},
|
|
{
|
|
"text": "(",
|
|
"kind": "punctuation"
|
|
}
|
|
],
|
|
"suffixDisplayParts": [
|
|
{
|
|
"text": ")",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": ":",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": " ",
|
|
"kind": "space"
|
|
},
|
|
{
|
|
"text": "c4",
|
|
"kind": "className"
|
|
}
|
|
],
|
|
"separatorDisplayParts": [
|
|
{
|
|
"text": ",",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": " ",
|
|
"kind": "space"
|
|
}
|
|
],
|
|
"parameters": [],
|
|
"documentation": [
|
|
{
|
|
"text": "Constructor comment",
|
|
"kind": "text"
|
|
}
|
|
],
|
|
"tags": []
|
|
}
|
|
],
|
|
"applicableSpan": {
|
|
"start": 298,
|
|
"length": 0
|
|
},
|
|
"selectedItemIndex": 0,
|
|
"argumentIndex": 0,
|
|
"argumentCount": 0
|
|
}
|
|
},
|
|
{
|
|
"marker": {
|
|
"fileName": "/tests/cases/fourslash/signatureHelpCommentsClass.ts",
|
|
"position": 393,
|
|
"name": "18"
|
|
},
|
|
"signatureHelp": {
|
|
"items": [
|
|
{
|
|
"isVariadic": false,
|
|
"prefixDisplayParts": [
|
|
{
|
|
"text": "c5",
|
|
"kind": "className"
|
|
},
|
|
{
|
|
"text": "(",
|
|
"kind": "punctuation"
|
|
}
|
|
],
|
|
"suffixDisplayParts": [
|
|
{
|
|
"text": ")",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": ":",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": " ",
|
|
"kind": "space"
|
|
},
|
|
{
|
|
"text": "c5",
|
|
"kind": "className"
|
|
}
|
|
],
|
|
"separatorDisplayParts": [
|
|
{
|
|
"text": ",",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": " ",
|
|
"kind": "space"
|
|
}
|
|
],
|
|
"parameters": [],
|
|
"documentation": [],
|
|
"tags": []
|
|
}
|
|
],
|
|
"applicableSpan": {
|
|
"start": 393,
|
|
"length": 0
|
|
},
|
|
"selectedItemIndex": 0,
|
|
"argumentIndex": 0,
|
|
"argumentCount": 0
|
|
}
|
|
},
|
|
{
|
|
"marker": {
|
|
"fileName": "/tests/cases/fourslash/signatureHelpCommentsClass.ts",
|
|
"position": 581,
|
|
"name": "23"
|
|
},
|
|
"signatureHelp": {
|
|
"items": [
|
|
{
|
|
"isVariadic": false,
|
|
"prefixDisplayParts": [
|
|
{
|
|
"text": "c6",
|
|
"kind": "className"
|
|
},
|
|
{
|
|
"text": "(",
|
|
"kind": "punctuation"
|
|
}
|
|
],
|
|
"suffixDisplayParts": [
|
|
{
|
|
"text": ")",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": ":",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": " ",
|
|
"kind": "space"
|
|
},
|
|
{
|
|
"text": "c6",
|
|
"kind": "className"
|
|
}
|
|
],
|
|
"separatorDisplayParts": [
|
|
{
|
|
"text": ",",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": " ",
|
|
"kind": "space"
|
|
}
|
|
],
|
|
"parameters": [],
|
|
"documentation": [
|
|
{
|
|
"text": "constructor comment",
|
|
"kind": "text"
|
|
}
|
|
],
|
|
"tags": []
|
|
}
|
|
],
|
|
"applicableSpan": {
|
|
"start": 581,
|
|
"length": 0
|
|
},
|
|
"selectedItemIndex": 0,
|
|
"argumentIndex": 0,
|
|
"argumentCount": 0
|
|
}
|
|
},
|
|
{
|
|
"marker": {
|
|
"fileName": "/tests/cases/fourslash/signatureHelpCommentsClass.ts",
|
|
"position": 716,
|
|
"name": "27"
|
|
},
|
|
"signatureHelp": {
|
|
"items": [
|
|
{
|
|
"isVariadic": false,
|
|
"prefixDisplayParts": [
|
|
{
|
|
"text": "a",
|
|
"kind": "className"
|
|
},
|
|
{
|
|
"text": "(",
|
|
"kind": "punctuation"
|
|
}
|
|
],
|
|
"suffixDisplayParts": [
|
|
{
|
|
"text": ")",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": ":",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": " ",
|
|
"kind": "space"
|
|
},
|
|
{
|
|
"text": "a",
|
|
"kind": "className"
|
|
}
|
|
],
|
|
"separatorDisplayParts": [
|
|
{
|
|
"text": ",",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": " ",
|
|
"kind": "space"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "a",
|
|
"documentation": [
|
|
{
|
|
"text": "this is my a",
|
|
"kind": "text"
|
|
}
|
|
],
|
|
"displayParts": [
|
|
{
|
|
"text": "a",
|
|
"kind": "parameterName"
|
|
},
|
|
{
|
|
"text": ":",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": " ",
|
|
"kind": "space"
|
|
},
|
|
{
|
|
"text": "string",
|
|
"kind": "keyword"
|
|
}
|
|
],
|
|
"isOptional": false,
|
|
"isRest": false
|
|
}
|
|
],
|
|
"documentation": [
|
|
{
|
|
"text": "constructor for a",
|
|
"kind": "text"
|
|
}
|
|
],
|
|
"tags": [
|
|
{
|
|
"name": "param",
|
|
"text": [
|
|
{
|
|
"text": "a",
|
|
"kind": "parameterName"
|
|
},
|
|
{
|
|
"text": " ",
|
|
"kind": "space"
|
|
},
|
|
{
|
|
"text": "this is my a",
|
|
"kind": "text"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"applicableSpan": {
|
|
"start": 716,
|
|
"length": 7
|
|
},
|
|
"selectedItemIndex": 0,
|
|
"argumentIndex": 0,
|
|
"argumentCount": 1
|
|
}
|
|
}
|
|
] |