History

Peter Bacon Darwin eedca09d73 build(aio): generate the api-list.json file from the API docs		2017-03-13 16:52:58 -07:00
..
includes	build(aio): big move of docs related files (#14361 )	2017-02-09 11:58:36 -08:00
layout	build(aio): big move of docs related files (#14361 )	2017-02-09 11:58:36 -08:00
lib	build(aio): big move of docs related files (#14361 )	2017-02-09 11:58:36 -08:00
README.md	build(aio): big move of docs related files (#14361 )	2017-02-09 11:58:36 -08:00
cheatsheet.template.json	build(aio): big move of docs related files (#14361 )	2017-02-09 11:58:36 -08:00
class.template.html	build(aio): big move of docs related files (#14361 )	2017-02-09 11:58:36 -08:00
const.template.html	build(aio): big move of docs related files (#14361 )	2017-02-09 11:58:36 -08:00
content.template.html	build(aio): big move of docs related files (#14361 )	2017-02-09 11:58:36 -08:00
data-module.template.js	build(aio): big move of docs related files (#14361 )	2017-02-09 11:58:36 -08:00
decorator.template.html	build(aio): big move of docs related files (#14361 )	2017-02-09 11:58:36 -08:00
directive.template.html	build(aio): big move of docs related files (#14361 )	2017-02-09 11:58:36 -08:00
enum.template.html	build(aio): big move of docs related files (#14361 )	2017-02-09 11:58:36 -08:00
example-region.template.html	build(aio): big move of docs related files (#14361 )	2017-02-09 11:58:36 -08:00
function.template.html	build(aio): big move of docs related files (#14361 )	2017-02-09 11:58:36 -08:00
interface.template.html	build(aio): big move of docs related files (#14361 )	2017-02-09 11:58:36 -08:00
json-doc.template.json	build(aio): big move of docs related files (#14361 )	2017-02-09 11:58:36 -08:00
let.template.html	build(aio): big move of docs related files (#14361 )	2017-02-09 11:58:36 -08:00
module.template.html	build(aio): big move of docs related files (#14361 )	2017-02-09 11:58:36 -08:00
overview-dump.template.html	build(aio): big move of docs related files (#14361 )	2017-02-09 11:58:36 -08:00
pipe.template.html	build(aio): big move of docs related files (#14361 )	2017-02-09 11:58:36 -08:00
type-alias.template.html	build(aio): big move of docs related files (#14361 )	2017-02-09 11:58:36 -08:00
value-module.template.html	fix(aio): support `ValueModule` symbols in the TypeScript source (#14464 )	2017-02-13 14:46:44 -08:00
var.template.html	build(aio): big move of docs related files (#14361 )	2017-02-09 11:58:36 -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 (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. Here is an overview:

class

docType
name
id
moduleDoc
path
description
notYetDocumented
members

directive

docType
name
id
moduleDoc
path
description
notYetDocumented
members

enum

docType
name
id
moduleDoc
path
description
notYetDocumented

var

docType
name
id
moduleDoc
path
description
notYetDocumented

const

docType
name
id
moduleDoc
path
description
notYetDocumented

let

docType
name
id
moduleDoc
path
description
notYetDocumented

decorator

docType
name
id
moduleDoc
path
description
notYetDocumented
members

function

docType
name
id
moduleDoc
path
description
notYetDocumented

interface

docType
name
id
moduleDoc
path
description
notYetDocumented
members

type-alias

docType
name
id
moduleDoc
path
description
notYetDocumented

pipe

docType
name
id
moduleDoc
path
description
notYetDocumented