honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
angular-cn/docs/templates
History
Pete Bacon Darwin d4ffa47ea6 fix(aio): correctly render decorator docs (#14328) 
This commit updates the doc-gen to account
for the changes to the codebase for decorators.

There are actually three kinds of calls that create decorators:

* makeDecorator
* makePropDecorator
* makeParamDecorator

Also, the actual documentation for each
decorator is split between two exported symbols:

* `interface [DecoratorName]` contains the metadata fields
* interface [DecoratorName]Decorator` contains a
  "call member" which holds the general description of the decorator.

This processor now identifies all three decorator types, and pulls the
description of the callMember onto the main decorator doc description.

(There are some outstanding interfaces in the angular/angular project that
need to be re-exported from `/angular/modules/@angular/core/src/metadata.ts`
to ensure that the doc-gen is able to access them.)

Closes https://github.com/angular/angular.io/pull/2349
 		2017-02-07 00:04:25 -08:00
..
includes fix(aio): correctly render decorator docs (#14328) 2017-02-07 00:04:25 -08:00
layout build(aio): remove formatting and styles from dgeni templates 2017-02-01 11:11:43 -08:00
lib build(aio): move doc-gen stuff from angular.io (#14097) 2017-01-26 23:46:59 -08:00
README.md build(aio): remove formatting and styles from dgeni templates 2017-02-01 11:11:43 -08:00
api-list-audit.template.json build(aio): move doc-gen stuff from angular.io (#14097) 2017-01-26 23:46:59 -08:00
api-list-data.template.json build(aio): move doc-gen stuff from angular.io (#14097) 2017-01-26 23:46:59 -08:00
cheatsheet.template.json build(aio): move doc-gen stuff from angular.io (#14097) 2017-01-26 23:46:59 -08:00
class.template.html build(aio): remove formatting and styles from dgeni templates 2017-02-01 11:11:43 -08:00
const.template.html build(aio): move doc-gen stuff from angular.io (#14097) 2017-01-26 23:46:59 -08:00
content.template.html build(aio): support guide authoring 2017-02-06 12:08:57 -08:00
data-module.template.js build(aio): move doc-gen stuff from angular.io (#14097) 2017-01-26 23:46:59 -08:00
decorator.template.html build(aio): remove formatting and styles from dgeni templates 2017-02-01 11:11:43 -08:00
directive.template.html build(aio): remove formatting and styles from dgeni templates 2017-02-01 11:11:43 -08:00
enum.template.html build(aio): move doc-gen stuff from angular.io (#14097) 2017-01-26 23:46:59 -08:00
example-region.template.html build(aio): move doc-gen stuff from angular.io (#14097) 2017-01-26 23:46:59 -08:00
function.template.html build(aio): remove formatting and styles from dgeni templates 2017-02-01 11:11:43 -08:00
interface.template.html build(aio): remove formatting and styles from dgeni templates 2017-02-01 11:11:43 -08:00
json-doc.template.json build(aio): move doc-gen stuff from angular.io (#14097) 2017-01-26 23:46:59 -08:00
let.template.html build(aio): move doc-gen stuff from angular.io (#14097) 2017-01-26 23:46:59 -08:00
module.template.html build(aio): remove formatting and styles from dgeni templates 2017-02-01 11:11:43 -08:00
overview-dump.template.html build(aio): move doc-gen stuff from angular.io (#14097) 2017-01-26 23:46:59 -08:00
pipe.template.html build(aio): remove formatting and styles from dgeni templates 2017-02-01 11:11:43 -08:00
type-alias.template.html build(aio): move doc-gen stuff from angular.io (#14097) 2017-01-26 23:46:59 -08:00
var.template.html build(aio): remove formatting and styles from dgeni templates 2017-02-01 11:11:43 -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