Open alexdiliberto opened 5 years ago
Thanks for opening this issue. On the long run investing effort into tsdoc is probably more valuable.
I just converted a huge chunk of ember-animated to TypeScript only to discover this issue. ðŸ˜
Has anyone tried to support TypeScript here?
Apparently the YUIDoc parser is sloppy enough to not care about the difference between JS and TS. This seems to be working fine:
https://github.com/ember-learn/ember-cli-addon-docs-yuidoc/compare/master...ef4:ts
The one good thing about a comment only parser 😄 it works in any language. We can also customize it to make it less terrible (as I have done) though probably should just rewrite it at some point.
@ef4 @pzuraq what do you guys suggest for TS? Should we recommend YUIDoc or should we try to implement something with TSDoc?
I agree with the comments above that tsdoc looks like a good bet. I started trying to integrate it just now, but decided I don't have time to do it, especially since the YUIDoc solution was so small.
Feature Request
Currently supported doc generators include YUIDoc and ESDoc
A future TypeScript doc generator option could include either TSDoc or TypeDoc