@summary jsdoc support

[Almenon]

========= Feature Request ============

It would be nice if @summary and @description paramaters were recognized in jsdocs to provide better intellisense. I'd consider the description of what the function does to be more important than its types. Visual Studio already has this feature.

[mjbvz]

Thanks. This is being tracked upstream on the TypeScript side: microsoft/TypeScript#13650

[mjbvz]

This should now be fixed. For the code:

/**
 * @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 '';
}

For hover we now display:

and for completion items we display:

This info is currently not rendered as markdown due to #11877

[Almenon]

thanks @mjbvz !

[wesleymostien]

What about the @return info?

[mjbvz]

@wesleymostien Opened #36462 for that