-
Notifications
You must be signed in to change notification settings - Fork 710
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
Include typedefs in typedocs #1214
Comments
Its seems reasonable to me to support this. I think there should be a special case for typedefs of type Couple notes when implementing:
|
That makes sense to me. In fact we had |
Well... I took another look at this, and turns out it wasn't nearly as painful to support as I thought! 0.20.6 works with it :) |
Problem
We declare some types using typedefs. You can see several examples of methods using this typedef in the same file. Example typedef:
https://github.com/chartjs/Chart.js/blob/0d6c05cca00813b0fb93396ce7b37b637f2e6833/src/core/core.scale.js#L11
However, method parameters in the Typedocs using this typedef appear as
any
(in this case I'd expect it to appear asTick
).Suggested Solution
Include typedefs as types in the generated documentation
The text was updated successfully, but these errors were encountered: