docs(alpha-34): API update fixes enums again and updates docs to v35

This commit is contained in:
Naomi Black
2015-08-06 23:25:42 -07:00
parent fa9567189f
commit 5fbd16f2f3
272 changed files with 1409 additions and 811 deletions
@@ -3,7 +3,7 @@
h2 Attribute <span class="type">variable</span>
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/annotations/decorators.ts#L360-L360">angular2/src/core/annotations/decorators.ts (line 360)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L360-L360">angular2/src/core/annotations/decorators.ts (line 360)</a>
:markdown
<a href='Attribute-var.html'><code>Attribute</code></a> factory function.
@@ -1,7 +1,7 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/annotations_impl/di.ts#L3-L44">angular2/src/core/annotations_impl/di.ts (line 3)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations_impl/di.ts#L3-L44">angular2/src/core/annotations_impl/di.ts (line 3)</a>
:markdown
Specifies that a constant attribute value should be injected.
@@ -1,7 +1,7 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/annotations/decorators.ts#L236-L287">angular2/src/core/annotations/decorators.ts (line 236)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L236-L287">angular2/src/core/annotations/decorators.ts (line 236)</a>
:markdown
<a href='Attribute-var.html'><code>Attribute</code></a> factory for creating annotations, decorators or DSL.
@@ -10,7 +10,7 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/util/decorators.ts#L119-L226">angular2/src/util/decorators.ts (line 119)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/util/decorators.ts#L119-L226">angular2/src/util/decorators.ts (line 119)</a>
:markdown
Provides a way for expressing ES6 classes with parameter annotations in ES5.
@@ -1,7 +1,7 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/util/decorators.ts#L1-L22">angular2/src/util/decorators.ts (line 1)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/util/decorators.ts#L1-L22">angular2/src/util/decorators.ts (line 1)</a>
:markdown
Declares the interface to be used with <a href='Class-function.html'><code>Class</code></a>.
@@ -3,7 +3,7 @@
h2 Component <span class="type">variable</span>
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/annotations/decorators.ts#L344-L345">angular2/src/core/annotations/decorators.ts (line 344)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L344-L345">angular2/src/core/annotations/decorators.ts (line 344)</a>
:markdown
<a href='Component-var.html'><code>Component</code></a> factory function.
@@ -1,7 +1,7 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/annotations_impl/annotations.ts#L778-L900">angular2/src/core/annotations_impl/annotations.ts (line 778)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations_impl/annotations.ts#L778-L900">angular2/src/core/annotations_impl/annotations.ts (line 778)</a>
:markdown
Declare reusable UI building blocks for an application.
@@ -1,7 +1,7 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/annotations/decorators.ts#L13-L32">angular2/src/core/annotations/decorators.ts (line 13)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L13-L32">angular2/src/core/annotations/decorators.ts (line 13)</a>
:markdown
Interface for the <a href='Component-var.html'><code>Component</code></a> decorator function.
@@ -1,7 +1,7 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/annotations/decorators.ts#L104-L174">angular2/src/core/annotations/decorators.ts (line 104)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L104-L174">angular2/src/core/annotations/decorators.ts (line 104)</a>
:markdown
<a href='ComponentAnnotation-class.html'><code>ComponentAnnotation</code></a> factory for creating annotations, decorators or DSL.
@@ -3,7 +3,7 @@
h2 Directive <span class="type">variable</span>
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/annotations/decorators.ts#L349-L349">angular2/src/core/annotations/decorators.ts (line 349)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L349-L349">angular2/src/core/annotations/decorators.ts (line 349)</a>
:markdown
<a href='Directive-var.html'><code>Directive</code></a> factory function.
@@ -1,7 +1,7 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/annotations_impl/annotations.ts#L4-L778">angular2/src/core/annotations_impl/annotations.ts (line 4)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations_impl/annotations.ts#L4-L778">angular2/src/core/annotations_impl/annotations.ts (line 4)</a>
:markdown
Directives allow you to attach behavior to elements in the DOM.
@@ -529,7 +529,7 @@ p.location-badge.
For example, we could write a binding that updates the directive on structural changes, rather
than on reference changes, as normally occurs in change detection.
See <a href='../change_detection/Pipe-interface.html'><code>Pipe</code></a> and <a href='../pipes/KeyValueChanges-class.html'><code>KeyValueChanges</code></a> documentation for more details.
See <a href='../change_detection/Pipe-interface.html'><code>Pipe</code></a> and `KeyValueChanges` documentation for more details.
```
@Directive({
@@ -1,7 +1,7 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/annotations/decorators.ts#L6-L13">angular2/src/core/annotations/decorators.ts (line 6)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L6-L13">angular2/src/core/annotations/decorators.ts (line 6)</a>
:markdown
Interface for the <a href='Directive-var.html'><code>Directive</code></a> decorator function.
@@ -1,7 +1,7 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/annotations/decorators.ts#L51-L104">angular2/src/core/annotations/decorators.ts (line 51)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L51-L104">angular2/src/core/annotations/decorators.ts (line 51)</a>
:markdown
<a href='Directive-var.html'><code>Directive</code></a> factory for creating annotations, decorators or DSL.
@@ -1,13 +1,176 @@
<h1>angular2/annotations/LifecycleEvent</h1>
<h2>(enum)</h2>
<div>
<p>Lifecycle events are guaranteed to be called in the following order:</p>
<ul>
<li><code>onChange</code> (optional if any bindings have changed),</li>
<li><code>onInit</code> (optional after the first check only),</li>
<li><code>onCheck</code>,</li>
<li><code>onAllChangesDone</code></li>
</ul>
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations_impl/annotations.ts#L900-L1032">angular2/src/core/annotations_impl/annotations.ts (line 900)</a>
:markdown
Lifecycle events are guaranteed to be called in the following order:
- `onChange` (optional if any bindings have changed),
- `onInit` (optional after the first check only),
- `onCheck`,
- `onAllChangesDone`
.l-main-section
h2 Members
.l-sub-section
h3 onDestroy
:markdown
Notify a directive whenever a <a href='View-var.html'><code>View</code></a> that contains it is destroyed.
```
@Directive({
...,
lifecycle: [LifecycleEvent.onDestroy]
})
class ClassSet {
onDestroy() {
// invoked to notify directive of the containing view destruction.
}
}
```
.l-sub-section
h3 onChange
:markdown
Notify a directive when any of its bindings have changed.
This method is called right after the directive's bindings have been checked,
and before any of its children's bindings have been checked.
It is invoked only if at least one of the directive's bindings has changed.
:
```
@Directive({
selector: '[class-set]',
properties: [
'propA',
'propB'
],
lifecycle: [LifecycleEvent.onChange]
})
class ClassSet {
propA;
propB;
onChange(changes:{[idx: string, PropertyUpdate]}) {
// This will get called after any of the properties have been updated.
if (changes['propA']) {
// if propA was updated
}
if (changes['propA']) {
// if propB was updated
}
}
}
```
.l-sub-section
h3 onCheck
:markdown
Notify a directive when it has been checked.
This method is called right after the directive's bindings have been checked,
and before any of its children's bindings have been checked.
It is invoked every time even when none of the directive's bindings has changed.
```
@Directive({
selector: '[class-set]',
lifecycle: [LifecycleEvent.onCheck]
})
class ClassSet {
onCheck() {
}
}
```
.l-sub-section
h3 onInit
:markdown
Notify a directive when it has been checked the first itme.
This method is called right after the directive's bindings have been checked,
and before any of its children's bindings have been checked.
It is invoked only once.
```
@Directive({
selector: '[class-set]',
lifecycle: [LifecycleEvent.onInit]
})
class ClassSet {
onInit() {
}
}
```
.l-sub-section
h3 onAllChangesDone
:markdown
Notify a directive when the bindings of all its children have been checked (whether they have
changed or not).
```
@Directive({
selector: '[class-set]',
lifecycle: [LifecycleEvent.onAllChangesDone]
})
class ClassSet {
onAllChangesDone() {
}
}
```
</div>
@@ -1,7 +1,7 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/compiler/interfaces.ts#L30-L37">angular2/src/core/compiler/interfaces.ts (line 30)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/compiler/interfaces.ts#L30-L37">angular2/src/core/compiler/interfaces.ts (line 30)</a>
:markdown
Defines lifecycle method
@@ -1,7 +1,7 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/compiler/interfaces.ts#L7-L12">angular2/src/core/compiler/interfaces.ts (line 7)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/compiler/interfaces.ts#L7-L12">angular2/src/core/compiler/interfaces.ts (line 7)</a>
:markdown
Defines lifecycle method <a href='annotations/LifeCycleEvent#onChange'>`LifeCycleEvent.onChange`</a>
@@ -1,7 +1,7 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/compiler/interfaces.ts#L18-L24">angular2/src/core/compiler/interfaces.ts (line 18)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/compiler/interfaces.ts#L18-L24">angular2/src/core/compiler/interfaces.ts (line 18)</a>
:markdown
Defines lifecycle method <a href='annotations/LifeCycleEvent#onCheck'>`LifeCycleEvent.onCheck`</a>
@@ -1,7 +1,7 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/compiler/interfaces.ts#L12-L18">angular2/src/core/compiler/interfaces.ts (line 12)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/compiler/interfaces.ts#L12-L18">angular2/src/core/compiler/interfaces.ts (line 12)</a>
:markdown
Defines lifecycle method <a href='annotations/LifeCycleEvent#onDestroy'>`LifeCycleEvent.onDestroy`</a>
@@ -1,7 +1,7 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/compiler/interfaces.ts#L24-L30">angular2/src/core/compiler/interfaces.ts (line 24)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/compiler/interfaces.ts#L24-L30">angular2/src/core/compiler/interfaces.ts (line 24)</a>
:markdown
Defines lifecycle method <a href='annotations/LifeCycleEvent#onInit'>`LifeCycleEvent.onInit`</a>
@@ -3,7 +3,7 @@
h2 Query <span class="type">variable</span>
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/annotations/decorators.ts#L365-L365">angular2/src/core/annotations/decorators.ts (line 365)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L365-L365">angular2/src/core/annotations/decorators.ts (line 365)</a>
:markdown
<a href='Query-var.html'><code>Query</code></a> factory function.
@@ -1,7 +1,7 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/annotations_impl/di.ts#L44-L69">angular2/src/core/annotations_impl/di.ts (line 44)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations_impl/di.ts#L44-L69">angular2/src/core/annotations_impl/di.ts (line 44)</a>
:markdown
Specifies that a <a href='../core/QueryList-class.html'><code>QueryList</code></a> should be injected.
@@ -1,7 +1,7 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/annotations/decorators.ts#L287-L338">angular2/src/core/annotations/decorators.ts (line 287)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L287-L338">angular2/src/core/annotations/decorators.ts (line 287)</a>
:markdown
<a href='Query-var.html'><code>Query</code></a> factory for creating annotations, decorators or DSL.
@@ -1,7 +1,7 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/util/decorators.ts#L22-L69">angular2/src/util/decorators.ts (line 22)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/util/decorators.ts#L22-L69">angular2/src/util/decorators.ts (line 22)</a>
:markdown
An interface implemented by all Angular type decorators, which allows them to be used as ES7
@@ -3,7 +3,7 @@
h2 View <span class="type">variable</span>
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/annotations/decorators.ts#L354-L355">angular2/src/core/annotations/decorators.ts (line 354)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L354-L355">angular2/src/core/annotations/decorators.ts (line 354)</a>
:markdown
<a href='View-var.html'><code>View</code></a> factory function.
@@ -1,7 +1,7 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/annotations_impl/view.ts#L4-L113">angular2/src/core/annotations_impl/view.ts (line 4)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations_impl/view.ts#L4-L113">angular2/src/core/annotations_impl/view.ts (line 4)</a>
:markdown
Declares the available HTML templates for an application.
@@ -1,7 +1,7 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/annotations/decorators.ts#L32-L51">angular2/src/core/annotations/decorators.ts (line 32)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L32-L51">angular2/src/core/annotations/decorators.ts (line 32)</a>
:markdown
Interface for the <a href='View-var.html'><code>View</code></a> decorator function.
@@ -1,7 +1,50 @@
<h1>angular2/annotations/ViewEncapsulation</h1>
<h2>(enum)</h2>
<div>
<p>How the template and styles of a view should be encapsulated.</p>
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/render/api.ts#L274-L293">angular2/src/render/api.ts (line 274)</a>
:markdown
How the template and styles of a view should be encapsulated.
.l-main-section
h2 Members
.l-sub-section
h3 EMULATED
:markdown
Emulate scoping of styles by preprocessing the style rules
and adding additional attributes to elements. This is the default.
.l-sub-section
h3 NATIVE
:markdown
Uses the native mechanism of the renderer. For the DOM this means creating a ShadowRoot.
.l-sub-section
h3 NONE
:markdown
Don't scope the template nor the styles.
</div>
@@ -1,7 +1,7 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/annotations/decorators.ts#L174-L236">angular2/src/core/annotations/decorators.ts (line 174)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L174-L236">angular2/src/core/annotations/decorators.ts (line 174)</a>
:markdown
<a href='ViewAnnotation-class.html'><code>ViewAnnotation</code></a> factory for creating annotations, decorators or DSL.
@@ -3,7 +3,7 @@
h2 ViewQuery <span class="type">variable</span>
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/annotations/decorators.ts#L371-L371">angular2/src/core/annotations/decorators.ts (line 371)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L371-L371">angular2/src/core/annotations/decorators.ts (line 371)</a>
:markdown
<a href='ViewQuery-var.html'><code>ViewQuery</code></a> factory function.
@@ -1,5 +1,5 @@
p.location-badge.
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/annotations.ts#L1-L48">angular2/annotations.ts (line 1)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/annotations.ts#L1-L48">angular2/annotations.ts (line 1)</a>
ul
for page, slug in public.docs[current.path[1]][current.path[2]][current.path[3]][current.path[4]]._data

Some files were not shown because too many files have changed in this diff Show More