Typescript: jsDoc use overloaded function documentations in intellisense.

Created on 15 Apr 2019  ·  4Comments  ·  Source: microsoft/TypeScript

Issue Type: Feature Request

It would be nice to see variations of functions documented like below code, when typing the function. I documented overloaded function according to this link https://github.com/jsdoc3/jsdoc/issues/1017 .

/**
 * Returns imported styles in 'dir/dir/style.scss' format.
 * @returns {string[]} Imported style's paths.
 *//**
* Returns imported styles in 'dir/dir/style.scss' format.
* @param {string} content File content to be used in operation.
* @returns {string[]} Imported style's paths.
*/
StyleFile.prototype.getImportedStylePaths = function (content) {
    if (!content)
        content = this.content;
....
}

Current behavior when typing.
issue-overload-1
Expected to be like below. ( Would like to see '+ overload').
issue-overload-2
And current behavior after typing
issue-overload-3
Expected. I would like to move with arrows between variations.
overload-issue-4

VS Code version: Code 1.33.0 (0dd516dd412d42323fc3464531b1c715d51c4c1a, 2019-04-04T15:14:28.026Z)
OS version: Windows_NT x64 10.0.17134

Awaiting More Feedback Suggestion

All 4 comments

Related #25590

@aliemre1990 good luck waiting for a few years before this issue gets addressed. MS only wants people to use TS so I wouldn't count on your issue being resolved any time soon. If you reading this in 2021, what did I say?

Duplicate of #25590.

@aliemre1990 good luck waiting for a few years before this issue gets addressed. MS only wants people to use TS so I wouldn't count on your issue being resolved any time soon. If you reading this in 2021, what did I say?

You seem to have a point, almost 2021 now.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

wmaurer picture wmaurer  ·  3Comments

kyasbal-1994 picture kyasbal-1994  ·  3Comments

fwanicka picture fwanicka  ·  3Comments

jbondc picture jbondc  ·  3Comments

MartynasZilinskas picture MartynasZilinskas  ·  3Comments