-
Notifications
You must be signed in to change notification settings - Fork 123
JSDoc of component properties or events in template is not displayed properly #1902
Description
🐞 bug report
Is this a regression?
No
Description
JSDoc information of a component property or event should be displayed in template. But if the JSDoc is long or have a blank leading line, or have block tags such as @description, the information is not displayed properly. The JSDoc information can be displayed properly in .ts file.
For example, given the following property with JSDoc, in .ts file, the whole information is displayed when the property is hover over, but in HTML template, it only displays *.
/***
* @description
* whether to filter null value if no item is selected
***/
@Input() nullValueFilterable = false;Expected is all the information should be displayed in HTML template.
Bug Type
What does this bug affect
- Angular Language Service VSCode extension
- Angular Language Service server
Screenshots
If applicable, add screenshots to help explain your problem.
JSDoc information displayed in .ts file:
* displayed in HTML template:
It seems that, in HTML template, the JSDoc is displayed if ONLY the JSDoc is in one line and has no block tags such as @desc, @example or so.
For example, after update the JSDoc to the following text without the @description block tag, the information is displayed in HTML template (but treated as dotted list with a trailing blank line).
/***
* whether to filter null value if no item is selected
***/
🌍 Your Environment
Angular Version:
_ _ ____ _ ___
/ \ _ __ __ _ _ _| | __ _ _ __ / ___| | |_ _|
/ △ \ | '_ \ / _` | | | | |/ _` | '__| | | | | | |
/ ___ \| | | | (_| | |_| | | (_| | | | |___| |___ | |
/_/ \_\_| |_|\__, |\__,_|_|\__,_|_| \____|_____|___|
|___/
Angular CLI: 14.2.11
Node: 16.19.1
Package Manager: npm 9.7.2
OS: darwin x64
Angular: 14.3.0
... animations, common, compiler, compiler-cli, core, elements
... forms, language-service, platform-browser
... platform-browser-dynamic, router
Package Version
---------------------------------------------------------
@angular-devkit/architect 0.1402.11
@angular-devkit/build-angular 14.2.11
@angular-devkit/core 14.2.11
@angular-devkit/schematics 14.2.11
@angular/cdk 14.2.7
@angular/cli 14.2.11
@angular/material 14.2.7
@schematics/angular 14.2.11
rxjs 7.8.0
typescript 4.6.4
Extension Version:
v16.0.0
VSCode Version:
Version: 1.80.0
Commit: 660393deaaa6d1996740ff4880f1bad43768c814
Date: 2023-07-04T13:39:33.766Z
Electron: 22.3.14
ElectronBuildId: 21893604
Chromium: 108.0.5359.215
Node.js: 16.17.1
V8: 10.8.168.25-electron.0
OS: Darwin x64 22.5.0
Operating System:
macOS: 13.4.1 (c) (22F770820d)
Extension options:
