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

Support parsing TSDoc string comments #95408

Closed
christianalfoni opened this issue Apr 16, 2020 · 1 comment
Closed

Support parsing TSDoc string comments #95408

christianalfoni opened this issue Apr 16, 2020 · 1 comment
Assignees
Labels
typescript Typescript support issues upstream Issue identified as 'upstream' component related (exists outside of VS Code)

Comments

@christianalfoni
Copy link

christianalfoni commented Apr 16, 2020

Hi there! I am using String Literal types to define classnames and would love to populate with some more information.

So basically:

type TClassnames = 
   /** Some docs about red-500 */
    | 'bg-color-red-500'
   /** Some docs about red-600 */
    | 'bg-color-red-600'

I would love to populate the docs on the right side of the intellisense:

Screenshot 2020-02-12 at 07 31 36

This is how we can document with properties:

Screenshot 2020-02-12 at 10 10 59

Which would be amazing to have on string literals.

I thought it was a TSDoc issue, but given this context: microsoft/tsdoc#164, it seems to be VSCode not parsing it?

@christianalfoni christianalfoni changed the title Support parting TSDoc string comments Support parsing TSDoc string comments Apr 16, 2020
@mjbvz
Copy link
Collaborator

mjbvz commented Apr 16, 2020

This feature is powered by the TypeScript project. Please file an issue upstream so that they can take a look

@mjbvz mjbvz closed this as completed Apr 16, 2020
@mjbvz mjbvz added typescript Typescript support issues upstream Issue identified as 'upstream' component related (exists outside of VS Code) labels Apr 16, 2020
@github-actions github-actions bot locked and limited conversation to collaborators May 31, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
typescript Typescript support issues upstream Issue identified as 'upstream' component related (exists outside of VS Code)
Projects
None yet
Development

No branches or pull requests

2 participants