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.

Sign up for GitHub

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

Jump to bottom

Document TSDoc support #467

Open
jsamr opened this issue Sep 13, 2020 · 0 comments
Open

Document TSDoc support #467

jsamr opened this issue Sep 13, 2020 · 0 comments

Comments

@jsamr
Copy link

jsamr commented Sep 13, 2020

Related to #458, but TSDoc (a tool maintained by Miscrosoft) although influenced by JSDoc, has a strictly distinct syntax. For example, @default in JSDOC is @defaultValue in TSDOC. @inheritDoc doesn't have the same semantics, and require an argument in TSDoc... etc.

The full specification is yet to be written, but there is already a very well documented syntax reference here. See microsoft/tsdoc#130 for updates on this specific issue.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jsamr