Skip to content
This repository was archived by the owner on Dec 4, 2017. It is now read-only.

Fix decorator docs#2349

Closed
petebacondarwin wants to merge 2 commits into
angular:masterfrom
petebacondarwin:fix-decorator-docs
Closed

Fix decorator docs#2349
petebacondarwin wants to merge 2 commits into
angular:masterfrom
petebacondarwin:fix-decorator-docs

Conversation

@petebacondarwin

Copy link
Copy Markdown
Contributor

No description provided.

@naomiblack

Copy link
Copy Markdown
Contributor

We are going to hold this one until later in the week. @IgorMinar says not urgent.

@petebacondarwin

Copy link
Copy Markdown
Contributor Author

Rebased and fixed up testing

@naomiblack

Copy link
Copy Markdown
Contributor

@IgorMinar is this one ready to merge? I'm not sure what it should look like in output -- not sure how to tell if it's done.

petebacondarwin added a commit to petebacondarwin/angular that referenced this pull request Feb 6, 2017
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 angular/angular.io#2349
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.)
@petebacondarwin

Copy link
Copy Markdown
Contributor Author

Rebasing and looking into a potential Travis error.

@petebacondarwin

petebacondarwin commented Feb 7, 2017

Copy link
Copy Markdown
Contributor Author

@wardbell I accidently caused this to close from a commit message in angular/angular. You might want to reopen this.

@IgorMinar IgorMinar reopened this Feb 7, 2017
asnowwolf pushed a commit to asnowwolf/angular that referenced this pull request Aug 11, 2017
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 angular/angular.io#2349
juleskremer pushed a commit to juleskremer/angular that referenced this pull request Aug 28, 2017
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 angular/angular.io#2349
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants