You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@annotator.apache.org by GitBox <gi...@apache.org> on 2020/11/05 17:11:12 UTC
[GitHub] [incubator-annotator] tilgovi opened a new issue #97: Generate TypeScript API documentation
tilgovi opened a new issue #97:
URL: https://github.com/apache/incubator-annotator/issues/97
Using tools from the microsoft/tsdoc ecosystem, create scripts to generate TypeScript API documentation.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-annotator] Treora commented on issue #97: Generate TypeScript API documentation
Posted by GitBox <gi...@apache.org>.
Treora commented on issue #97:
URL: https://github.com/apache/incubator-annotator/issues/97#issuecomment-756452883
@tilgovi Could you share/describe your attempt with tsdoc so far? I am curious what you used if not `api-documenter`, because it [looks like][1] `@microsoft/tsdoc` is not made for direct consumption:
> By itself, the @microsoft/tsdoc package is not a documentation solution you can use directly. It is an engine component used by other tools such as API Extractor. The NPM dependency report is an easy way to find tools that implement TSDoc.
Upon quick inspection I don’t see anything listed that look more mature than the api-documenter I tried in #101, but would be glad to find something nicer (it gets the job done though)
[1]: https://tsdoc.org/pages/intro/using_tsdoc/
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-annotator] tilgovi closed issue #97: Generate TypeScript API documentation
Posted by GitBox <gi...@apache.org>.
tilgovi closed issue #97:
URL: https://github.com/apache/incubator-annotator/issues/97
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-annotator] Treora commented on issue #97: Generate TypeScript API documentation
Posted by GitBox <gi...@apache.org>.
Treora commented on issue #97:
URL: https://github.com/apache/incubator-annotator/issues/97#issuecomment-756455419
Oh wait, there’s tsdoc.org and there is typedoc.org; please excuse my confusion. :) I suppose that’s what you tried; I’d be glad to try both and compare. It may still be helpful to see your setup, if you could push that as a branch.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org