Inline Documentation

Question

Inline Documentation

hbroer opened this issue 5 years ago · 2 comments

People suggested to add some inline documentation because they have problems to understand how the library works. This should be fixed.

Answer 1 · 2022-10-30T17:00:05.000Z

by inline you mean the JSDoc ?

Answer 2 · 2022-10-31T09:39:45.000Z

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.