10

Is there a documentation generator (may be a node package) like in other programming languages (jsdoc / phpdoc / javadoc / ..) for typescript-based Angular2-Projects?

Improve this question
3
  • dgeni github.com/rangle/angular2-dgeni-starter Commented Jun 21, 2016 at 17:00
  • Ja, danke/thank you, I now, also this seed (github.com/mgechev/angular2-seed) has npm run build.docs. But I would need a independent library/package/etc.. Commented Jun 22, 2016 at 7:40
  • I don't know where dgeny is maintained. I just posted the link to the starter pack because I assumed that it provides all the ingo how to use it. Commented Jun 22, 2016 at 7:42

2 Answers 2

Reset to default
15

This seems to be a viable solution :compodoc

Improve this answer
Sign up to request clarification or add additional context in comments.

3 Comments

Whilst this may theoretically answer the question, it would be preferable to include the essential parts of the answer here, and provide the link for reference.
I found compodoc-project was the best solution in case you have an angular2-project. The documentation covers everything you might expect from good docs, compodocs can identify angular2 modules/classes/services/annotations etc. and structures the output accordingly... Also, i found the included docs-coverage report very useful. Didn't try it with a pure typescript project, put i guess this would look like the output for 'pure' classes without annotations.
I found this tool the best for my Angular + TypeScript project.
10

If you are using TypeScript then "Typedoc.org" can be useful for you. http://typedoc.org/

Improve this answer

2 Comments

Ya, it got closed. I will find another
If you are going to use Typedoc, I recommend you to create your own conventions since the defaults are pretty basic. We took some inspiration from here.

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.