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

Generate API docs using typedoc.org #63

Open
tyohan opened this issue Apr 10, 2023 · 0 comments
Open

Generate API docs using typedoc.org #63

tyohan opened this issue Apr 10, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@tyohan
Copy link
Member

tyohan commented Apr 10, 2023

To have a better API reference for this SDK, it will be great to have an API reference that might be can be generated using https://typedoc.org/

This SDK already use JSDoc and the typedoc can extract the comments and generate a documentation for each API.

@tyohan tyohan added the enhancement New feature or request label Apr 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant