From http://stackoverflow.com/questions/42126703/visual-studio-code-display-jsdoc-for-attribute
TypeScript Version: 2.2.0-dev.20170207
Code
interface Point {
/** The x property */
x: number;
/** The y property */
y: number;
}
const p: Point = <Point>{
x: 10,
y: 10,
};
p.x;Expected behavior:
quickinfo for the x in x:10 shows the property info along with the documentation for x
Actual behavior:
Here's hovering over the x in x:10
[Trace - 5:45:18 PM] Sending request: quickinfo (507). Response expected: yes. Current queue length: 0
Arguments: {
"file": "/Users/matb/projects/sand/castle.ts",
"line": 9,
"offset": 6
}
[Trace - 5:45:18 PM] Response received: quickinfo (507). Request took 2 ms. Success: true
Result: {
"kind": "property",
"kindModifiers": "",
"start": {
"line": 9,
"offset": 5
},
"end": {
"line": 9,
"offset": 6
},
"displayString": "(property) x: number",
"documentation": ""
}
vs hovering over p.x:
[Trace - 5:46:10 PM] Sending request: quickinfo (509). Response expected: yes. Current queue length: 0
Arguments: {
"file": "/Users/matb/projects/sand/castle.ts",
"line": 13,
"offset": 4
}
[Trace - 5:46:10 PM] Response received: quickinfo (509). Request took 1 ms. Success: true
Result: {
"kind": "property",
"kindModifiers": "",
"start": {
"line": 13,
"offset": 3
},
"end": {
"line": 13,
"offset": 4
},
"displayString": "(property) Point.x: number",
"documentation": "The x property "
}
Note that completionEntryDetails for x in x:10 does return the documentation for Point.x
From http://stackoverflow.com/questions/42126703/visual-studio-code-display-jsdoc-for-attribute
TypeScript Version: 2.2.0-dev.20170207
Code
Expected behavior:
quickinfofor thexinx:10shows the property info along with the documentation forxActual behavior:
Here's hovering over the
xinx:10vs hovering over
p.x:Note that
completionEntryDetailsforxinx:10does return the documentation forPoint.x