ember-cli-addon-docs icon indicating copy to clipboard operation
ember-cli-addon-docs copied to clipboard

Published 20 hours ago • verified publisher icon ember-learn

Provide support for a compatible TypeScript doc generator

Open alexdiliberto opened this issue 7 years ago • 7 comments

Feature Request

Currently supported doc generators include YUIDoc and ESDoc

A future TypeScript doc generator option could include either TSDoc or TypeDoc

alexdiliberto avatar Sep 22 '18 17:09 alexdiliberto

Thanks for opening this issue. On the long run investing effort into tsdoc is probably more valuable.

buschtoens avatar Sep 22 '18 18:09 buschtoens

I just converted a huge chunk of ember-animated to TypeScript only to discover this issue. 😭

ef4 avatar Oct 28 '19 16:10 ef4

Has anyone tried to support TypeScript here?

RobbieTheWagner avatar Oct 28 '19 17:10 RobbieTheWagner

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

ef4 avatar Oct 28 '19 18:10 ef4

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.

pzuraq avatar Oct 28 '19 19:10 pzuraq

@ef4 @pzuraq what do you guys suggest for TS? Should we recommend YUIDoc or should we try to implement something with TSDoc?

RobbieTheWagner avatar Oct 28 '19 20:10 RobbieTheWagner

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.

ef4 avatar Oct 28 '19 20:10 ef4