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

feat: add JSDoc/TSDoc comments to output #294

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

jordanbtucker
Copy link

@jordanbtucker jordanbtucker commented Sep 18, 2022

This is a work-in-progress proof of concept PR for including JSDoc/TSDoc comments in the output.

It currently works with type aliases and their properties, functions and their required parameters, and optional parameter properties.

It works with deprecations for operations and parameters.

It still needs tests.

Will fix #57

@jordanbtucker jordanbtucker changed the title feat: add JSDoc comments to output feat: add JSDoc/TSDoc comments to output Sep 18, 2022
@trim21
Copy link
Contributor

trim21 commented Mar 19, 2023

Is there any progress on this?

Or fo you mind I cherry-pick this pr?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Transform descriptions and examples into TSDoc comments
2 participants