honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
angular-cn/aio/tools/transforms/templates
History
Peter Bacon Darwin 1762047bc0 build(aio): fix other dgeni templates 
The function and interface templates were overriding the
wrong block.
 		2017-04-25 07:35:34 +01:00
..
includes build(aio): fix rendering of Decorator API docs 2017-04-25 07:35:34 +01:00
layout build(aio): move the `transforms` folder into the `tools` folder 2017-04-16 22:05:23 +01:00
lib build(aio): move the `transforms` folder into the `tools` folder 2017-04-16 22:05:23 +01:00
README.md build(aio): move the `transforms` folder into the `tools` folder 2017-04-16 22:05:23 +01:00
class.template.html feat(aio): api page styles 2017-04-21 16:24:37 +01:00
const.template.html build(aio): move the `transforms` folder into the `tools` folder 2017-04-16 22:05:23 +01:00
content.template.html build(aio): render titles correctly in content pages 2017-04-19 10:42:38 +01:00
data-module.template.js build(aio): move the `transforms` folder into the `tools` folder 2017-04-16 22:05:23 +01:00
decorator.template.html build(aio): fix rendering of Decorator API docs 2017-04-25 07:35:34 +01:00
directive.template.html build(aio): move the `transforms` folder into the `tools` folder 2017-04-16 22:05:23 +01:00
enum.template.html build(aio): move the `transforms` folder into the `tools` folder 2017-04-16 22:05:23 +01:00
example-region.template.html build(aio): move the `transforms` folder into the `tools` folder 2017-04-16 22:05:23 +01:00
function.template.html build(aio): fix other dgeni templates 2017-04-25 07:35:34 +01:00
interface.template.html build(aio): fix other dgeni templates 2017-04-25 07:35:34 +01:00
json-doc.template.json build(aio): move the `transforms` folder into the `tools` folder 2017-04-16 22:05:23 +01:00
let.template.html build(aio): move the `transforms` folder into the `tools` folder 2017-04-16 22:05:23 +01:00
module.template.html build(aio): move the `transforms` folder into the `tools` folder 2017-04-16 22:05:23 +01:00
overview-dump.template.html build(aio): move the `transforms` folder into the `tools` folder 2017-04-16 22:05:23 +01:00
pipe.template.html build(aio): move the `transforms` folder into the `tools` folder 2017-04-16 22:05:23 +01:00
type-alias.template.html build(aio): move the `transforms` folder into the `tools` folder 2017-04-16 22:05:23 +01:00
value-module.template.html build(aio): move the `transforms` folder into the `tools` folder 2017-04-16 22:05:23 +01:00
var.template.html build(aio): move the `transforms` folder into the `tools` folder 2017-04-16 22:05:23 +01: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