store icon indicating copy to clipboard operation
store copied to clipboard

TypeDoc all the things

Open SethDavenport opened this issue 8 years ago • 0 comments

This is a...

  • [x] feature request
  • [ ] bug report
  • [ ] usage question

What toolchain are you using for transpilation/bundling?

  • [ ] @angular/cli
  • [ ] Custom @ngTools/webpack
  • [ ] Raw ngc
  • [ ] SystemJS
  • [ ] Rollup
  • [x] Other

Environment

All

Link to repo showing the issue

https://angular-redux.github.io/store/

Expected Behaviour:

All exported types in the API docs should have a typedoc comment explaining what they're for. Bonus points for generic types and parameters too!

Actual Behaviour:

A lot of the constructs in the API docs have very little description of what they do. We should beef up our typedoc comments to address this for all publicly exported types.

SethDavenport avatar Jul 11 '17 14:07 SethDavenport