2017-01-27 09:51:41 -05:00
|
|
|
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 (base)
|
|
|
|
|
- module.template.html
|
|
|
|
|
- layout/api-base.template.html (jumpNav, jumpNavLinks, whatItDoes, infoBar, securityConsiderations, deprecationNotes, howToUse, details)
|
|
|
|
|
- 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
|
|
|
|
|
- type-alias.template.html
|
|
|
|
|
- pipe.template.html
|
|
|
|
|
|
|
|
|
|
# Doc Properties
|
|
|
|
|
|
|
|
|
|
It is useful to know what properties are available on each doc type when working with the templates.
|
2017-07-15 12:31:48 -04:00
|
|
|
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.
|
