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

Inline Documentation #33

Open
hbroer opened this issue Oct 18, 2019 · 2 comments
Open

Inline Documentation #33

hbroer opened this issue Oct 18, 2019 · 2 comments
Labels
enhancement New feature or request
Projects
V2 - Step into the future

Comments

@hbroer
Copy link
Contributor

hbroer commented Oct 18, 2019

People suggested to add some inline documentation because they have problems to understand how the library works. This should be fixed.
@hbroer hbroer added the enhancement New feature or request label Oct 18, 2019
@hbroer hbroer mentioned this issue Oct 18, 2019
Open
@vic1707
Copy link
Contributor

vic1707 commented Oct 30, 2022

by inline you mean the JSDoc ?

@hbroer
Copy link
Contributor Author

hbroer commented Oct 31, 2022

hey, yea kind of. I think it can help others to understand what is going on to add some documentation to the classes, functions and methods. Also how the decorator works etc. This has no high priority.

I don't like to add jsdoc types manualy and I did not do any research yet on a solution to add/update jsdoc automaticaly based on typescript types.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
V2 - Step into the future
  
Awaiting triage
Milestone
No milestone
Development

No branches or pull requests
2 participants
@hbroer @vic1707