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
187 lines
3.5 KiB
Plaintext
187 lines
3.5 KiB
Plaintext
[
|
|
{
|
|
"marker": {
|
|
"fileName": "/tests/cases/fourslash/quickInfoJsDocTags6.js",
|
|
"position": 308,
|
|
"name": ""
|
|
},
|
|
"quickInfo": {
|
|
"kind": "method",
|
|
"kindModifiers": "",
|
|
"textSpan": {
|
|
"start": 308,
|
|
"length": 6
|
|
},
|
|
"displayParts": [
|
|
{
|
|
"text": "(",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": "method",
|
|
"kind": "text"
|
|
},
|
|
{
|
|
"text": ")",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": " ",
|
|
"kind": "space"
|
|
},
|
|
{
|
|
"text": "Bar",
|
|
"kind": "className"
|
|
},
|
|
{
|
|
"text": ".",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": "method",
|
|
"kind": "methodName"
|
|
},
|
|
{
|
|
"text": "(",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": "x",
|
|
"kind": "parameterName"
|
|
},
|
|
{
|
|
"text": ":",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": " ",
|
|
"kind": "space"
|
|
},
|
|
{
|
|
"text": "any",
|
|
"kind": "keyword"
|
|
},
|
|
{
|
|
"text": ",",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": " ",
|
|
"kind": "space"
|
|
},
|
|
{
|
|
"text": "y",
|
|
"kind": "parameterName"
|
|
},
|
|
{
|
|
"text": ":",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": " ",
|
|
"kind": "space"
|
|
},
|
|
{
|
|
"text": "any",
|
|
"kind": "keyword"
|
|
},
|
|
{
|
|
"text": ")",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": ":",
|
|
"kind": "punctuation"
|
|
},
|
|
{
|
|
"text": " ",
|
|
"kind": "space"
|
|
},
|
|
{
|
|
"text": "number",
|
|
"kind": "keyword"
|
|
}
|
|
],
|
|
"documentation": [
|
|
{
|
|
"text": "comment",
|
|
"kind": "text"
|
|
}
|
|
],
|
|
"tags": [
|
|
{
|
|
"name": "author",
|
|
"text": [
|
|
{
|
|
"text": "Me <me@domain.tld>",
|
|
"kind": "text"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "see",
|
|
"text": [
|
|
{
|
|
"text": "x",
|
|
"kind": "text"
|
|
},
|
|
{
|
|
"text": " ",
|
|
"kind": "space"
|
|
},
|
|
{
|
|
"text": "(the parameter)",
|
|
"kind": "text"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "param",
|
|
"text": [
|
|
{
|
|
"text": "x",
|
|
"kind": "parameterName"
|
|
},
|
|
{
|
|
"text": " ",
|
|
"kind": "space"
|
|
},
|
|
{
|
|
"text": "- x comment",
|
|
"kind": "text"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "param",
|
|
"text": [
|
|
{
|
|
"text": "y",
|
|
"kind": "parameterName"
|
|
},
|
|
{
|
|
"text": " ",
|
|
"kind": "space"
|
|
},
|
|
{
|
|
"text": "- y comment",
|
|
"kind": "text"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "returns",
|
|
"text": [
|
|
{
|
|
"text": "The result",
|
|
"kind": "text"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "inheritDoc"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
] |