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

Salsa does not recognize JSDoc parameter properties in object literal format on multiple lines #10535

Closed
abgivant opened this issue Aug 25, 2016 · 2 comments · Fixed by #10671
Assignees
Labels
Bug A bug in TypeScript Fixed A PR has been merged for this issue

Comments

@abgivant
Copy link

When calling a function with object parameters documented with JSDoc, Visual Studio Code will not give intellisense completions if the parameter was documented using the object literal format with the comment broken up over multiple lines.

This type of formatting allows for better readability when documenting objects with a lot of properties, so it would be helpful if this was supported.

TypeScript Version: 2.1.0-dev.20160824

Code


Expected behavior:

The properties of an object parameter should be recognized when it is documented using the JSDoc object literal @param syntax, even if the comment spans multiple lines.

Actual behavior:

No properties of the object are recognized unless the JSDoc comment is only a single line.

@mhegazy
Copy link
Contributor

mhegazy commented Aug 25, 2016

@sandersn looks related to your jsdoc parsing.

@sandersn
Copy link
Member

Yep, my changes should fix this since jsdoc type parsing now delegates to the real typescript type parser, which of course doesn't care about whitespace.

(Note: object literal types aren't actually standard jsdoc, they seem to have been introduced by Closure and TypeScript.)

@mhegazy mhegazy added the Fixed A PR has been merged for this issue label Sep 15, 2016
@microsoft microsoft locked and limited conversation to collaborators Jun 19, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Bug A bug in TypeScript Fixed A PR has been merged for this issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants