From 9d30e6da413b08cca46ed14529bfbf9e4bd35719 Mon Sep 17 00:00:00 2001 From: Naomi Black Date: Mon, 18 May 2015 17:39:04 -0700 Subject: [PATCH] docs(api): update API docs to head --- .../docs/js/latest/api/annotations/_data.json | 4 +- .../ChangeDetection-class.jade | 2 +- .../DynamicChangeDetection-class.jade | 4 +- .../JitChangeDetection-class.jade | 4 +- .../api/core/ViewContainerRef-class.jade | 2 +- .../DependencyAnnotation-class.jade | 2 +- .../api/di_annotations/Inject-class.jade | 2 +- .../api/di_annotations/InjectLazy-class.jade | 2 +- .../di_annotations/InjectPromise-class.jade | 2 +- .../api/di_annotations/Injectable-class.jade | 2 +- .../api/di_annotations/Optional-class.jade | 2 +- .../api/pipes/AsyncPipeFactory-class.jade | 14 +++++ .../pipes/CollectionChangeRecord-class.jade | 2 +- .../api/pipes/IterableChanges-class.jade | 2 +- .../api/pipes/KVChangeRecord-class.jade | 2 +- .../api/pipes/KeyValueChanges-class.jade | 2 +- .../pipes/KeyValueChangesFactory-class.jade | 14 +++++ .../js/latest/api/pipes/NullPipe-class.jade | 2 +- .../api/pipes/NullPipeFactory-class.jade | 14 +++++ .../docs/js/latest/api/pipes/Pipe-class.jade | 2 +- .../latest/api/pipes/WrappedValue-class.jade | 53 +++++++++++++++++++ public/docs/js/latest/api/pipes/_data.json | 4 ++ .../js/latest/api/router/Router-class.jade | 39 ++++++-------- public/docs/js/latest/api/router/_data.json | 4 ++ .../api/router/routerInjectables-var.jade | 9 ++++ .../js/latest/api/view/Compiler-class.jade | 4 +- .../latest/api/view/ComponentRef-class.jade | 2 +- .../view/DynamicComponentLoader-class.jade | 2 +- 28 files changed, 152 insertions(+), 47 deletions(-) create mode 100644 public/docs/js/latest/api/pipes/WrappedValue-class.jade create mode 100644 public/docs/js/latest/api/router/routerInjectables-var.jade diff --git a/public/docs/js/latest/api/annotations/_data.json b/public/docs/js/latest/api/annotations/_data.json index bec55c2516..aececb1801 100644 --- a/public/docs/js/latest/api/annotations/_data.json +++ b/public/docs/js/latest/api/annotations/_data.json @@ -1,7 +1,7 @@ { "index" : { "title" : "Annotations", - "intro" : "Annotations provide the additional information that Angular requires in order to run your application. This module contains Component, Directive, and View annotations, as well as Parent and Ancestor annotations that are used by Angular to resolve dependencies." + "intro" : "Annotations provide the additional information that Angular requires in order to run your application. This modulecontains Component, Directive, and View annotations, as well as Parent and Ancestor annotations that areused by Angular to resolve dependencies." }, "Directive-class" : { @@ -43,4 +43,4 @@ "Ancestor-class" : { "title" : "Ancestor Class" } -} +} \ No newline at end of file diff --git a/public/docs/js/latest/api/change_detection/ChangeDetection-class.jade b/public/docs/js/latest/api/change_detection/ChangeDetection-class.jade index f9bf8a688c..526d393aa4 100644 --- a/public/docs/js/latest/api/change_detection/ChangeDetection-class.jade +++ b/public/docs/js/latest/api/change_detection/ChangeDetection-class.jade @@ -32,7 +32,7 @@ p.location-badge. pre.prettyprint code. - createProtoChangeDetector(name:string, changeControlStrategy:string=DEFAULT) + createProtoChangeDetector(name:string, bindingRecords:List, variableBindings:List, directiveRecords:List, changeControlStrategy:string=DEFAULT) :markdown diff --git a/public/docs/js/latest/api/change_detection/DynamicChangeDetection-class.jade b/public/docs/js/latest/api/change_detection/DynamicChangeDetection-class.jade index 89186ca003..5175c268c1 100644 --- a/public/docs/js/latest/api/change_detection/DynamicChangeDetection-class.jade +++ b/public/docs/js/latest/api/change_detection/DynamicChangeDetection-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/change_detection - defined in angular2/src/change_detection/change_detection.js (line 55) + defined in angular2/src/change_detection/change_detection.js (line 59) :markdown Implements change detection that does not require `eval()`. @@ -30,7 +30,7 @@ p.location-badge. pre.prettyprint code. - createProtoChangeDetector(name:string, changeControlStrategy:string = DEFAULT) + createProtoChangeDetector(name:string, bindingRecords:List<BindingRecord>, variableBindings:List<string>, directiveRecords:List<DirectiveRecord>, changeControlStrategy:string = DEFAULT) :markdown diff --git a/public/docs/js/latest/api/change_detection/JitChangeDetection-class.jade b/public/docs/js/latest/api/change_detection/JitChangeDetection-class.jade index cd62a0144c..0fbdad88c1 100644 --- a/public/docs/js/latest/api/change_detection/JitChangeDetection-class.jade +++ b/public/docs/js/latest/api/change_detection/JitChangeDetection-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/change_detection - defined in angular2/src/change_detection/change_detection.js (line 76) + defined in angular2/src/change_detection/change_detection.js (line 81) :markdown Implements faster change detection, by generating source code. @@ -30,7 +30,7 @@ p.location-badge. pre.prettyprint code. - createProtoChangeDetector(name:string, changeControlStrategy:string = DEFAULT) + createProtoChangeDetector(name:string, bindingRecords:List<BindingRecord>, variableBindings:List<string>, directiveRecords:List<DirectiveRecord>, changeControlStrategy:string = DEFAULT) :markdown diff --git a/public/docs/js/latest/api/core/ViewContainerRef-class.jade b/public/docs/js/latest/api/core/ViewContainerRef-class.jade index 66a58d7b26..5aebb2ad15 100644 --- a/public/docs/js/latest/api/core/ViewContainerRef-class.jade +++ b/public/docs/js/latest/api/core/ViewContainerRef-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/core - defined in angular2/src/core/compiler/view_container_ref.js (line 12) + defined in angular2/src/core/compiler/view_container_ref.js (line 11) :markdown diff --git a/public/docs/js/latest/api/di_annotations/DependencyAnnotation-class.jade b/public/docs/js/latest/api/di_annotations/DependencyAnnotation-class.jade index 028c28b977..a53ec0ecde 100644 --- a/public/docs/js/latest/api/di_annotations/DependencyAnnotation-class.jade +++ b/public/docs/js/latest/api/di_annotations/DependencyAnnotation-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/di_annotations - defined in angular2/src/di/annotations.js (line 110) + defined in angular2/src/di/annotations_impl.js (line 110) :markdown `DependencyAnnotation` is used by the framework to extend DI. diff --git a/public/docs/js/latest/api/di_annotations/Inject-class.jade b/public/docs/js/latest/api/di_annotations/Inject-class.jade index 3ea4b91b32..28dc2a3881 100644 --- a/public/docs/js/latest/api/di_annotations/Inject-class.jade +++ b/public/docs/js/latest/api/di_annotations/Inject-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/di_annotations - defined in angular2/src/di/annotations.js (line 13) + defined in angular2/src/di/annotations_impl.js (line 13) :markdown A parameter annotation that specifies a dependency. diff --git a/public/docs/js/latest/api/di_annotations/InjectLazy-class.jade b/public/docs/js/latest/api/di_annotations/InjectLazy-class.jade index 2288e3ac2b..42a87ffe08 100644 --- a/public/docs/js/latest/api/di_annotations/InjectLazy-class.jade +++ b/public/docs/js/latest/api/di_annotations/InjectLazy-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/di_annotations - defined in angular2/src/di/annotations.js (line 55) + defined in angular2/src/di/annotations_impl.js (line 55) :markdown A parameter annotation that creates a synchronous lazy dependency. diff --git a/public/docs/js/latest/api/di_annotations/InjectPromise-class.jade b/public/docs/js/latest/api/di_annotations/InjectPromise-class.jade index cea5d6dfcd..3828527831 100644 --- a/public/docs/js/latest/api/di_annotations/InjectPromise-class.jade +++ b/public/docs/js/latest/api/di_annotations/InjectPromise-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/di_annotations - defined in angular2/src/di/annotations.js (line 34) + defined in angular2/src/di/annotations_impl.js (line 34) :markdown A parameter annotation that specifies a `Promise` of a dependency. diff --git a/public/docs/js/latest/api/di_annotations/Injectable-class.jade b/public/docs/js/latest/api/di_annotations/Injectable-class.jade index 180ebfcb81..d4c4257981 100644 --- a/public/docs/js/latest/api/di_annotations/Injectable-class.jade +++ b/public/docs/js/latest/api/di_annotations/Injectable-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/di_annotations - defined in angular2/src/di/annotations.js (line 134) + defined in angular2/src/di/annotations_impl.js (line 134) :markdown A marker annotation that marks a class as available to `Injector` for creation. Used by tooling for diff --git a/public/docs/js/latest/api/di_annotations/Optional-class.jade b/public/docs/js/latest/api/di_annotations/Optional-class.jade index 47b892dd91..8ca8ff459e 100644 --- a/public/docs/js/latest/api/di_annotations/Optional-class.jade +++ b/public/docs/js/latest/api/di_annotations/Optional-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/di_annotations - defined in angular2/src/di/annotations.js (line 77) + defined in angular2/src/di/annotations_impl.js (line 77) :markdown A parameter annotation that marks a dependency as optional. Injector provides `null` if the dependency is not diff --git a/public/docs/js/latest/api/pipes/AsyncPipeFactory-class.jade b/public/docs/js/latest/api/pipes/AsyncPipeFactory-class.jade index 5f8e107dd5..2368d6fabe 100644 --- a/public/docs/js/latest/api/pipes/AsyncPipeFactory-class.jade +++ b/public/docs/js/latest/api/pipes/AsyncPipeFactory-class.jade @@ -8,6 +8,20 @@ p.location-badge. .l-main-section h2 Members + .l-sub-section + h3 constructor + + + pre.prettyprint + code. + constructor() + + :markdown + + + + + .l-sub-section h3 create diff --git a/public/docs/js/latest/api/pipes/CollectionChangeRecord-class.jade b/public/docs/js/latest/api/pipes/CollectionChangeRecord-class.jade index c16828a03d..589276fa8b 100644 --- a/public/docs/js/latest/api/pipes/CollectionChangeRecord-class.jade +++ b/public/docs/js/latest/api/pipes/CollectionChangeRecord-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/pipes - defined in angular2/src/change_detection/pipes/iterable_changes.js (line 509) + defined in angular2/src/change_detection/pipes/iterable_changes.js (line 515) :markdown diff --git a/public/docs/js/latest/api/pipes/IterableChanges-class.jade b/public/docs/js/latest/api/pipes/IterableChanges-class.jade index 544ab05509..f5bbab2043 100644 --- a/public/docs/js/latest/api/pipes/IterableChanges-class.jade +++ b/public/docs/js/latest/api/pipes/IterableChanges-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/pipes - defined in angular2/src/change_detection/pipes/iterable_changes.js (line 31) + defined in angular2/src/change_detection/pipes/iterable_changes.js (line 37) :markdown diff --git a/public/docs/js/latest/api/pipes/KVChangeRecord-class.jade b/public/docs/js/latest/api/pipes/KVChangeRecord-class.jade index c6febc5700..c2012dd3c0 100644 --- a/public/docs/js/latest/api/pipes/KVChangeRecord-class.jade +++ b/public/docs/js/latest/api/pipes/KVChangeRecord-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/pipes - defined in angular2/src/change_detection/pipes/keyvalue_changes.js (line 360) + defined in angular2/src/change_detection/pipes/keyvalue_changes.js (line 365) :markdown diff --git a/public/docs/js/latest/api/pipes/KeyValueChanges-class.jade b/public/docs/js/latest/api/pipes/KeyValueChanges-class.jade index 36c01a25a1..36d0336e5c 100644 --- a/public/docs/js/latest/api/pipes/KeyValueChanges-class.jade +++ b/public/docs/js/latest/api/pipes/KeyValueChanges-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/pipes - defined in angular2/src/change_detection/pipes/keyvalue_changes.js (line 21) + defined in angular2/src/change_detection/pipes/keyvalue_changes.js (line 26) :markdown diff --git a/public/docs/js/latest/api/pipes/KeyValueChangesFactory-class.jade b/public/docs/js/latest/api/pipes/KeyValueChangesFactory-class.jade index fcb06dd299..be5d2d284e 100644 --- a/public/docs/js/latest/api/pipes/KeyValueChangesFactory-class.jade +++ b/public/docs/js/latest/api/pipes/KeyValueChangesFactory-class.jade @@ -7,6 +7,20 @@ p.location-badge. .l-main-section h2 Members + .l-sub-section + h3 constructor + + + pre.prettyprint + code. + constructor() + + :markdown + + + + + .l-sub-section h3 create diff --git a/public/docs/js/latest/api/pipes/NullPipe-class.jade b/public/docs/js/latest/api/pipes/NullPipe-class.jade index 4c37ac0e41..b490e1fb7e 100644 --- a/public/docs/js/latest/api/pipes/NullPipe-class.jade +++ b/public/docs/js/latest/api/pipes/NullPipe-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/pipes - defined in angular2/src/change_detection/pipes/null_pipe.js (line 19) + defined in angular2/src/change_detection/pipes/null_pipe.js (line 24) :markdown diff --git a/public/docs/js/latest/api/pipes/NullPipeFactory-class.jade b/public/docs/js/latest/api/pipes/NullPipeFactory-class.jade index c7df0af1aa..1ba205e81e 100644 --- a/public/docs/js/latest/api/pipes/NullPipeFactory-class.jade +++ b/public/docs/js/latest/api/pipes/NullPipeFactory-class.jade @@ -7,6 +7,20 @@ p.location-badge. .l-main-section h2 Members + .l-sub-section + h3 constructor + + + pre.prettyprint + code. + constructor() + + :markdown + + + + + .l-sub-section h3 create diff --git a/public/docs/js/latest/api/pipes/Pipe-class.jade b/public/docs/js/latest/api/pipes/Pipe-class.jade index f234751acf..0198417b8c 100644 --- a/public/docs/js/latest/api/pipes/Pipe-class.jade +++ b/public/docs/js/latest/api/pipes/Pipe-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/pipes - defined in angular2/src/change_detection/pipes/pipe.js (line 52) + defined in angular2/src/change_detection/pipes/pipe.js (line 54) :markdown An interface for extending the list of pipes known to Angular. diff --git a/public/docs/js/latest/api/pipes/WrappedValue-class.jade b/public/docs/js/latest/api/pipes/WrappedValue-class.jade new file mode 100644 index 0000000000..55e037155e --- /dev/null +++ b/public/docs/js/latest/api/pipes/WrappedValue-class.jade @@ -0,0 +1,53 @@ + +p.location-badge. + exported from angular2/pipes + defined in angular2/src/change_detection/pipes/pipe.js (line 9) + +:markdown + Indicates that the result of a Pipe transformation has changed even though the reference has not changed. + + The wrapped value will be unwrapped by change detection, and the unwrapped value will be stored. + +.l-main-section + h2 Members + .l-sub-section + h3 constructor + + + pre.prettyprint + code. + constructor(wrapped:any) + + :markdown + + + + + + .l-sub-section + h3 wrap + + + pre.prettyprint + code. + wrap(value:any) + + :markdown + + + + + + + + .l-sub-section + h3 wrapped + + + :markdown + + + + + + diff --git a/public/docs/js/latest/api/pipes/_data.json b/public/docs/js/latest/api/pipes/_data.json index 514cc7f69c..d4999bf15a 100644 --- a/public/docs/js/latest/api/pipes/_data.json +++ b/public/docs/js/latest/api/pipes/_data.json @@ -52,6 +52,10 @@ "title" : "NullPipe Class" }, + "WrappedValue-class" : { + "title" : "WrappedValue Class" + }, + "Pipe-class" : { "title" : "Pipe Class" } diff --git a/public/docs/js/latest/api/router/Router-class.jade b/public/docs/js/latest/api/router/Router-class.jade index 137f0edaf1..66b0f08841 100644 --- a/public/docs/js/latest/api/router/Router-class.jade +++ b/public/docs/js/latest/api/router/Router-class.jade @@ -1,10 +1,10 @@ p.location-badge. exported from angular2/router - defined in angular2/src/router/router.js (line 18) + defined in angular2/src/router/router.js (line 19) :markdown - ## Router + # Router The router is responsible for mapping URLs to components. You can see the state of the router by inspecting the read-only field `router.navigating`. @@ -18,7 +18,7 @@ p.location-badge. pre.prettyprint code. - constructor(registry:RouteRegistry, pipeline:Pipeline, parent:Router = null, name = '/') + constructor(registry:RouteRegistry, pipeline:Pipeline, location:Location, parent:Router, hostComponent) :markdown @@ -64,16 +64,25 @@ p.location-badge. pre.prettyprint code. - config(path:string, component, alias:string=null) + config(config:any) :markdown Update the routing configuration and trigger a navigation. - ### Usage + # Usage ``` - router.config('/', SomeCmp); + router.config({ 'path': '/', 'component': IndexCmp}); + ``` + + Or: + + ``` + router.config([ + { 'path': '/', 'component': IndexComp }, + { 'path': '/user/:id', 'component': UserComp }, + ]); ``` @@ -97,13 +106,9 @@ p.location-badge. .l-sub-section - h3 getRoot + h3 hostComponent - pre.prettyprint - code. - getRoot() - :markdown @@ -124,18 +129,6 @@ p.location-badge. - .l-sub-section - h3 name - - - :markdown - - - - - - - .l-sub-section h3 navigate diff --git a/public/docs/js/latest/api/router/_data.json b/public/docs/js/latest/api/router/_data.json index 2a71f9595c..4bc8616b44 100644 --- a/public/docs/js/latest/api/router/_data.json +++ b/public/docs/js/latest/api/router/_data.json @@ -4,6 +4,10 @@ "intro" : "Maps application URLs into application states, to support deep-linking and navigation." }, + "routerInjectables-var" : { + "title" : "routerInjectables Var" + }, + "Router-class" : { "title" : "Router Class" }, diff --git a/public/docs/js/latest/api/router/routerInjectables-var.jade b/public/docs/js/latest/api/router/routerInjectables-var.jade new file mode 100644 index 0000000000..7e9bcd0f06 --- /dev/null +++ b/public/docs/js/latest/api/router/routerInjectables-var.jade @@ -0,0 +1,9 @@ + +.l-main-section + h2 routerInjectables variable + p.location-badge. + exported from angular2/router + + :markdown + + diff --git a/public/docs/js/latest/api/view/Compiler-class.jade b/public/docs/js/latest/api/view/Compiler-class.jade index e15cfc078c..d75ea1972c 100644 --- a/public/docs/js/latest/api/view/Compiler-class.jade +++ b/public/docs/js/latest/api/view/Compiler-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/view - defined in angular2/src/core/compiler/compiler.js (line 47) + defined in angular2/src/core/compiler/compiler.js (line 48) :markdown @@ -13,7 +13,7 @@ p.location-badge. pre.prettyprint code. - constructor(reader: DirectiveMetadataReader, cache:CompilerCache, templateResolver: TemplateResolver, componentUrlMapper: ComponentUrlMapper, urlResolver: UrlResolver, renderer: renderApi.Renderer, protoViewFactory: ProtoViewFactory) + constructor(reader: DirectiveMetadataReader, cache:CompilerCache, templateResolver: TemplateResolver, componentUrlMapper: ComponentUrlMapper, urlResolver: UrlResolver, render: renderApi.RenderCompiler, protoViewFactory: ProtoViewFactory) :markdown diff --git a/public/docs/js/latest/api/view/ComponentRef-class.jade b/public/docs/js/latest/api/view/ComponentRef-class.jade index 9e8c8bfbc2..4e69784962 100644 --- a/public/docs/js/latest/api/view/ComponentRef-class.jade +++ b/public/docs/js/latest/api/view/ComponentRef-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/view - defined in angular2/src/core/compiler/dynamic_component_loader.js (line 10) + defined in angular2/src/core/compiler/dynamic_component_loader.js (line 11) :markdown diff --git a/public/docs/js/latest/api/view/DynamicComponentLoader-class.jade b/public/docs/js/latest/api/view/DynamicComponentLoader-class.jade index 2693b71c90..def8e1714a 100644 --- a/public/docs/js/latest/api/view/DynamicComponentLoader-class.jade +++ b/public/docs/js/latest/api/view/DynamicComponentLoader-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/view - defined in angular2/src/core/compiler/dynamic_component_loader.js (line 37) + defined in angular2/src/core/compiler/dynamic_component_loader.js (line 38) :markdown Service for dynamically loading a Component into an arbitrary position in the internal Angular