History

Pete Bacon Darwin 85f5cb45d2 build(docs-infra): associate providedIn injectables with their NgModule (#41960 )

Such injectables were not appearing in the providers lists of their NgModule.
This commit updates the doc-gen to support associating these automatically.
Further, it also allows developers to mark other injectables that are provided
in an NgModule with a reference to the NgModule where they are provided.

The commit also does a refactoring of the `processNgModuleDocs` dgeni
processor code, to make it easier to maintain.

Fixes #41203

PR Close #41960

2021-05-10 10:28:30 -04:00

api

build(docs-infra): associate providedIn injectables with their NgModule (#41960 )

2021-05-10 10:28:30 -04:00

cli

docs: update CLI MAN page format (#40038 )

2020-12-14 11:31:07 -08:00

error

docs: add embedded videos to error guides (#40453 )

2021-01-20 08:47:00 -08:00

lib

build(docs-infra): display github links in CLI API docs (#26515 )

2018-10-19 11:12:54 -07:00

content.template.html

build(docs-infra): implement @reviewed tag definition (#40582 )

2021-01-28 09:04:49 -08:00

data-module.template.js

build(aio): move the transforms folder into the tools folder

2017-04-16 22:05:23 +01:00

disambiguator.template.html

build(docs-infra): add path disambiguation (#41788 )

2021-04-26 12:12:00 -07:00

example-region.template.html

build(aio): move the transforms folder into the tools folder

2017-04-16 22:05:23 +01:00

json-doc.template.json

build(aio): move the transforms folder into the tools folder

2017-04-16 22:05:23 +01:00

overview-dump.template.html

refactor(docs-infra): refactor templates (#24378 )

2018-08-31 09:42:10 -07:00

README.md

build(docs-infra): remove legacy jsdoc tag processing (#26039 )

2018-09-24 09:11:02 -07:00

sitemap.template.xml

build(aio): generate sitemap from the generated pages (#21689 )

2018-01-22 12:55:15 -08:00

README.md

This folder contains the dgeni templates that are used to generate the API docs

Generally there is a template for each docType. Templates can extend and/or include other templates. Templates can also import macros from other template files.

Template inheritance

When extending a template, parent must declare blocks that can be overridden by the child. The template extension hierarchy looks like this (with declared blocks in parentheses):

layout/base.template.html (bread-crumbs, header, embedded contents and body)
- package.template.html
- export-base.template.html (short-description, security-notes, deprecation, overview, see-also, details, usageNotes)
  - class.template.html
    - directive.template.html
  - enum.template.html
  - var.template.html
    - const.template.html
    - let.template.html
  - decorator.template.html
  - function.template.html
  - interface.template.html
    - value-module.template.html
  - type-alias.template.html
  - pipe.template.html
  - ngmodule.template.html

Doc Properties

It is useful to know what properties are available on each doc type when working with the templates. The typescript Dgeni package is now written in TypeScript and there is a class for each of the types of API document. See https://github.com/angular/dgeni-packages/tree/master/typescript/src/api-doc-types. This is a good place to go to see what properties you can use in the templates.