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

Support JSDoc tags in the generated declaration file #19

Closed
Robbson opened this issue Oct 12, 2020 · 2 comments
Closed

Support JSDoc tags in the generated declaration file #19

Robbson opened this issue Oct 12, 2020 · 2 comments
Assignees
@Robbson
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@Robbson
Copy link

Robbson commented Oct 12, 2020

We should provide support for JSDoc tags in addition to the already supported comment lines in the generated .d.ts file.

This way an API consumer gets all available documentation like parameter descriptions, examples, deprecation warnings etc.
@FlorianRappl FlorianRappl added enhancement New feature or request help wanted Extra attention is needed labels Oct 12, 2020
@Robbson Robbson mentioned this issue Oct 12, 2020
Merged
@Robbson
Copy link
Author

Robbson commented Oct 12, 2020

#20

@FlorianRappl
Copy link
Owner

Landed in develop and the preview (of 0.8.0).

Thanks for the outstanding contribution @Robbson ! 🍻

@SantoJambit SantoJambit mentioned this issue Dec 11, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Robbson Robbson

Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@FlorianRappl @Robbson