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 2021/01/07 23:39:45 UTC

[GitHub] [incubator-annotator] Treora commented on issue #97: Generate TypeScript API documentation

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