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

JSDoc @summary tag #13650

Closed
tinganho opened this issue Jan 24, 2017 · 1 comment
Closed

JSDoc @summary tag #13650

tinganho opened this issue Jan 24, 2017 · 1 comment
Assignees
Labels
Bug A bug in TypeScript Domain: JSDoc Relates to JSDoc parsing and type generation Fixed A PR has been merged for this issue VS Code Tracked There is a VS Code equivalent to this issue

Comments

@tinganho
Copy link
Contributor

I propose to use the jsdoc @summary tag when showing the hover information.

screen shot 2017-01-24 at 9 48 01 am

/**
 * @summary 
 * Get Document body.
 *
 * @description
 * Get the document body of the view. Sometimes, it is useful to render an
 * alert view or notify the user of something that have happened. These views
 * are owned by the document body, so to reference the document body, you use
 * `this.document`. And it is only, `ContentBaseView` and it derivatives that
 * has a reference to the document body.
 *
 * @example
 * ```
 * render () {
 *     return (
 *         <div className='NameField'>{this.l('NAME_FIELD')}</div>
 *     );
 * }
 * ```
 */
function getDocument() {
    return '';
}

Right now, the summary of the hover info is empty. I guess it doesn't recognize it at the moment?

@mhegazy mhegazy added Bug A bug in TypeScript Domain: JSDoc Relates to JSDoc parsing and type generation labels Feb 22, 2017
@mhegazy mhegazy added this to the TypeScript 2.3 milestone Feb 22, 2017
@mjbvz mjbvz added the VS Code Tracked There is a VS Code equivalent to this issue label May 10, 2017
@mhegazy mhegazy removed this from the TypeScript 2.4 milestone May 11, 2017
@mjbvz
Copy link
Contributor

mjbvz commented Dec 22, 2017

I believe this tag is now displayed in TS 2.7 with VS Code insiders 1.20:

screen shot 2017-12-21 at 4 27 24 pm

@mjbvz mjbvz closed this as completed Dec 22, 2017
@mhegazy mhegazy added this to the TypeScript 2.7 milestone Jan 11, 2018
@mhegazy mhegazy added the Fixed A PR has been merged for this issue label Jan 11, 2018
@microsoft microsoft locked and limited conversation to collaborators Jul 3, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Bug A bug in TypeScript Domain: JSDoc Relates to JSDoc parsing and type generation Fixed A PR has been merged for this issue VS Code Tracked There is a VS Code equivalent to this issue
Projects
None yet
Development

No branches or pull requests

4 participants