Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Intellisense should inherit documentation for Interfaces. #29516

Open
patrick-janeiro opened this issue Jan 18, 2019 · 4 comments
Open

Intellisense should inherit documentation for Interfaces. #29516

patrick-janeiro opened this issue Jan 18, 2019 · 4 comments
Labels
Experience Enhancement Noncontroversial enhancements Suggestion An idea for TypeScript
Milestone

Comments

@patrick-janeiro
Copy link

When implementing an interface the intellisense feature is capable of detecting the description of the interface however it does not carry over any tags such as @param and @returns.

Below is a picture of an example:

image

You can see that the description is properly shown however the param and returns tag is not.
What is expected:

image

@mjbvz mjbvz transferred this issue from microsoft/vscode Jan 21, 2019
@mjbvz
Copy link
Contributor

mjbvz commented Jan 21, 2019

Tested with TS 3.3.0-dev.20190119

Example code:

interface IFoo {
    /**
     * Does stuff 
     * 
     * @param x An argument
     */
    bar(x): void
}

class Foo implements IFoo {
    bar(x: any): void {
        console.log(x)
    }
}

Request is to have the quickInfo also include the jsdoc tags property for the implementation method

@mjbvz mjbvz removed their assignment Jan 21, 2019
@RyanCavanaugh RyanCavanaugh added Suggestion An idea for TypeScript Experience Enhancement Noncontroversial enhancements labels Jan 23, 2019
@RyanCavanaugh
Copy link
Member

There is a duplicate of this somewhere but I can't find it at the moment.

@RyanCavanaugh RyanCavanaugh added this to the Backlog milestone Aug 16, 2019
@KillyMXI
Copy link

I wonder if this is related to #28470
Here it is about classes implementing an interface, there it is about something extending an interface.
But it look suspiciously similar otherwise.

@jonyeezs
Copy link

issue is on typescript version 3.9.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Experience Enhancement Noncontroversial enhancements Suggestion An idea for TypeScript
Projects
None yet
Development

No branches or pull requests

5 participants