covalent
covalent copied to clipboard
Teradata
Generate Documentation from TypeScript
Feature Request
Generate Documentation from TypeScript automatically. Ideally this would be automated.
What is the expected behavior?
A possible solution is to add a build step to generate code comment docs, and insert the file via td-markdown.
What is the motivation / use case for changing the behavior?
Covalent in many cases is being used as an API, so having code level documentation will help people when integrating, as well as knowing documentation is being generated from the code is a good incentive to write good inline comments.
Which version of Angular and Material, and which browser and OS does this issue affect?
All versions
Other information
A possible solution is to use TypeDoc from here: http://typedoc.org/
I've been following the TypeDoc project for a while. I know it is being used for the new ui-router documentation. It's the best TypeScript documentation tool I know of but it has a few rough edges.
The original maintainer isn't taking care of it so it's now a community effort. However few people really understand the code enough to implement major features. TypeScript 2.x support is still a WIP and some features like readonly or newer tsconfig.json properties aren't working yet.
@aciccarello Is there any other TypeScript documentation tool that you know of that we should look into instead or is TypeDoc the best you know of for now?
It's the best one I know of. I've also heard of other people generating docs from the outputted JS with comments but that's kinda a lossy process.
I would watch @angular over the next month or two, my suspicion is they will end up rolling a documentation generation tool for TypeScript as https://material.angular.io/ is generated content.
That may or may not be suitable for everyones needs, we will just have to wait and see.
