-**Deprecation Notice:** This implementation of the Component Router (ngComponentRouter module) has been deprecated and will not receive further updates.
-Alternatively, use the {@link ngRoute} module or community developed projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
+
+**Deprecation Notice:** In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module) has been deprecated and will not receive further updates.
+We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
This guide describes the new Component Router for AngularJS 1.5.
diff --git a/src/ngComponentRouter/Router.js b/src/ngComponentRouter/Router.js
index 550323ee428c..5ad5057b2fd9 100644
--- a/src/ngComponentRouter/Router.js
+++ b/src/ngComponentRouter/Router.js
@@ -3,11 +3,11 @@
* @name ngComponentRouter
* @installation
*
- *
- * **Deprecation Notice:** This implementation of the Component Router has been deprecated and will not receive further updates.
- * Alternatively, use the {@link ngRoute} module or community developed projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
+ *
+ * **Deprecation Notice:** In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module) has been deprecated and will not receive further updates.
+ * We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
*
-
+ *
* Currently, the **Component Router** module must be installed via `npm`, it is not yet available
* on Bower or the Google CDN.
*
@@ -42,7 +42,6 @@
* @ngdoc type
* @name Router
* @description
- * @deprecated This implementation of the Component Router has been deprecated and should not be used anymore.
* A `Router` is responsible for mapping URLs to components.
*
* * Routers and "Routing Component" instances have a 1:1 correspondence.
@@ -52,39 +51,53 @@
* You can see the state of a router by inspecting the read-only field `router.navigating`.
* This may be useful for showing a spinner, for instance.
*
+ * @deprecated
+ * In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module)
+ * has been deprecated and will not receive further updates.
+ * We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed
+ * projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
*/
/**
* @ngdoc type
* @name ChildRouter
* @description
- * @deprecated This implementation of the Component Router has been deprecated and should not be used anymore.
*
* This type extends the {@link Router}.
*
* Apart from the **Top Level Component** ({@link $routerRootComponent}) which is associated with
* the {@link $rootRouter}, every **Routing Component** is associated with a `ChildRouter`,
* which manages the routing for that **Routing Component**.
+ *
+ * @deprecated
+ * In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module)
+ * has been deprecated and will not receive further updates.
+ * We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed
+ * projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
*/
/**
* @ngdoc type
* @name RootRouter
* @description
- * @deprecated This implementation of the Component Router has been deprecated and should not be used anymore.
*
* This type extends the {@link Router}.
*
* There is only one instance of this type in a Component Router application injectable as the
* {@link $rootRouter} service. This **Router** is associate with the **Top Level Component**
* ({@link $routerRootComponent}). It acts as the connection between the **Routers** and the **Location**.
+ *
+ * @deprecated
+ * In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module)
+ * has been deprecated and will not receive further updates.
+ * We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed
+ * projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
*/
/**
* @ngdoc type
* @name ComponentInstruction
* @description
- * @deprecated This implementation of the Component Router has been deprecated and should not be used anymore.
*
* A `ComponentInstruction` represents the route state for a single component. An `Instruction` is
* composed of a tree of these `ComponentInstruction`s.
@@ -93,13 +106,18 @@
* to route lifecycle hooks, like `$routerCanActivate`.
*
* You should not modify this object. It should be treated as immutable.
+ *
+ * @deprecated
+ * In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module)
+ * has been deprecated and will not receive further updates.
+ * We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed
+ * projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
*/
/**
* @ngdoc type
* @name RouteDefinition
* @description
- * @deprecated This implementation of the Component Router has been deprecated and should not be used anymore.
*
* Each item in the **RouteConfig** for a **Routing Component** is an instance of
* this type. It can have the following properties:
@@ -108,16 +126,27 @@
* * `component`, `loader`, `redirectTo` (requires exactly one of these)
* * `name` - the name used to identify the **Route Definition** when generating links
* * `data` (optional)
+ *
+ * @deprecated
+ * In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module)
+ * has been deprecated and will not receive further updates.
+ * We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed
+ * projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
*/
/**
* @ngdoc type
* @name RouteParams
* @description
- * @deprecated This implementation of the Component Router has been deprecated and should not be used anymore.
*
* A map of parameters for a given route, passed as part of the {@link ComponentInstruction} to
* the Lifecycle Hooks, such as `$routerOnActivate` and `$routerOnDeactivate`.
+ *
+ * @deprecated
+ * In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module)
+ * has been deprecated and will not receive further updates.
+ * We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed
+ * projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
*/
/**
@@ -126,15 +155,19 @@
* @priority 400
* restrict: AE
* @description
- * @deprecated This implementation of the Component Router has been deprecated and should not be used anymore.
*
* The directive that identifies where the {@link Router} should render its **Components**.
+ *
+ * @deprecated
+ * In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module)
+ * has been deprecated and will not receive further updates.
+ * We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed
+ * projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
*/
/**
* @name ngLink
* @description
- * @deprecated This implementation of the Component Router has been deprecated and should not be used anymore.
*
* Lets you create links to different views, automatically generating the `href`.
*
@@ -144,6 +177,12 @@
* ```html
*
Link to Child View
* ````
+ *
+ * @deprecated
+ * In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module)
+ * has been deprecated and will not receive further updates.
+ * We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed
+ * projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
*/
@@ -151,10 +190,15 @@
* @ngdoc service
* @name $rootRouter
* @description
- * @deprecated This implementation of the Component Router has been deprecated and should not be used anymore.
*
* The singleton instance of the {@link RootRouter} type, which is associated
* with the top level {@link $routerRootComponent}.
+ *
+ * @deprecated
+ * In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module)
+ * has been deprecated and will not receive further updates.
+ * We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed
+ * projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
*/
@@ -162,7 +206,12 @@
* @ngdoc service
* @name $routerRootComponent
* @description
- * @deprecated This implementation of the Component Router has been deprecated and should not be used anymore.
*
* The top level **Routing Component** associated with the {@link $rootRouter}.
+ *
+ * @deprecated
+ * In an effort to keep synchronized with router changes in Angular 2, this implementation of the Component Router (ngComponentRouter module)
+ * has been deprecated and will not receive further updates.
+ * We are investigating backporting the Angular 2 Router to Angular 1, but alternatively, use the {@link ngRoute} module or community developed
+ * projects (e.g. [ui-router](https://github.com/angular-ui/ui-router)).
*/