doc: integrate documentation generation

[dsebastien]

Properly integrate documentation generation in Stark and in the starter

• design (select lib, how to generate and where)
• review typedoc config: build & all: review typedoc config #42
• integrate at root
• integrate in all packages
• integrate in the starter (isolated config)

[dsebastien]

Old internal docs/pointers:

Goal: describe how to document code for our applications (ES/TS).

Depending on the basic stack we've chosen, we should be able to identify tools to document our code (e.g., JSDoc or TypeDoc?).

Also, we should see if there's a mean to link this with code quality checks (i.e., is enough code documented or not).

We also need support in the IDE for the chosen solution!

References to check:

• http://typedoc.io/
• http://stackoverflow.com/questions/16263480/generate-documentation-for-typescript
• https://toddmotto.com/documenting-angular-dgeni
• https://esdoc.org/
• http://usejsdoc.org/
• http://yui.github.io/yuidoc/

Goal: finalize discussions around code documentation and produce documentation for the developer guide.

To cover:

• present DGeni to the project team
• test dgeni (now has TS support)
• how to document code (inline doc)
• how to generate static site with API docs (mostly useful for Stark itself, could be useful to others; currently managed by TSDoc)
• how to leverage docs for tests (dgeni?)

Documentation page to complete: https://confluence.prd.nbb/display/jag/Front-end+code+documentation

[dsebastien]

DGeni:

• https://toddmotto.com/documenting-angular-dgeni
• https://github.com/rangle/angular2-dgeni-starter

JSDoc:

• http://usejsdoc.org

Compodoc:

• https://github.com/compodoc/compodoc
• https://compodoc.app/guides/installation.html

Compodoc selected as it has very nice Angular support (modules, injectables, routes, ...)

[dsebastien]

Docs will be generated under reports/api-docs/<package name>