chore(ng2): Rename UIROUTER_(PROVIDER|DIRECTIVE)S for deprecation warnings

Author: christopherthielen

src/ng2/directives/directives.ts

@@ -17,8 +17,10 @@ export * from "./uiSref";
 export * from "./uiSrefStatus";
 export * from "./uiSrefActive";
 
+export const _UIROUTER_DIRECTIVES = [UISref, AnchorUISref, UIView, UISrefActive, UISrefStatus];
+
 /**
  * References to the UI-Router directive classes, for use within a @Component's `directives:` property
  * @deprecated use [[UIRouterModule]]
  */
-export let UIROUTER_DIRECTIVES = [UISref, AnchorUISref, UIView, UISrefActive, UISrefStatus];
+export const UIROUTER_DIRECTIVES = _UIROUTER_DIRECTIVES;

src/ng2/providers.ts

@@ -138,12 +138,7 @@ let uiRouterFactory = (injector: Injector) => {
   return router;
 };
 
-/**
- * The UI-Router providers, for use in your application bootstrap
- *
- * @deprecated use [[UIRouterModule]]
- */
-export const UIROUTER_PROVIDERS: ProviderLike[] = [
+export const _UIROUTER_PROVIDERS: ProviderLike[] = [
   { provide: UIRouterLocation, useClass: UIRouterLocation },
   { provide: UIRouter, useFactory: uiRouterFactory, deps: [Injector] },
 
@@ -156,4 +151,10 @@ export const UIROUTER_PROVIDERS: ProviderLike[] = [
   { provide: Globals,           useFactory: (r: UIRouter) => r.globals          , deps: [UIRouter]},
 
   { provide: UIView.PARENT_INJECT, useFactory: (r: StateRegistry) => { return { fqn: null, context: r.root() } as ParentUIViewInject }, deps: [StateRegistry]}
-];
+]
+/**
+ * The UI-Router providers, for use in your application bootstrap
+ *
+ * @deprecated use [[UIRouterModule]]
+ */
+export const UIROUTER_PROVIDERS = _UIROUTER_PROVIDERS;

src/ng2/uiRouterNgModule.ts

@@ -1,15 +1,15 @@
 import {Ng2StateDeclaration} from "./interface";
 import {NgModule, NgModuleMetadataType, OpaqueToken} from "@angular/core";
-import {UIROUTER_DIRECTIVES} from "./directives/directives";
-import {UIROUTER_PROVIDERS} from "./providers";
+import {_UIROUTER_DIRECTIVES} from "./directives/directives";
+import {_UIROUTER_PROVIDERS} from "./providers";
 import {UIView} from "./directives/uiView";
 import {uniqR, flattenR} from "../common/common";
 
 @NgModule({
-  declarations: [UIROUTER_DIRECTIVES],
-  exports: [UIROUTER_DIRECTIVES],
+  declarations: [_UIROUTER_DIRECTIVES],
+  exports: [_UIROUTER_DIRECTIVES],
   entryComponents: [UIView],
-  providers: [UIROUTER_PROVIDERS]
+  providers: [_UIROUTER_PROVIDERS]
 })
 export class UIRouterRootModule {}
 
@@ -39,12 +39,31 @@ export const UIROUTER_STATES_TOKEN = new OpaqueToken("UIRouter States");
  * 
  * var homeState = { name: 'home', url: '/home', component: Home };
  * var aboutState = { name: 'about', url: '/about', component: About };
+ *
  * @UIRouterModule({
  *   imports: [BrowserModule],
  *   declarations: [NonRoutedComponent],
  *   states: [homeState, aboutState]
  * }) export class AppModule {};
  * ```
+ *
+ * The `UIRouterModule` decorator creates an Angular 2 `NgModule`.
+ * The equivalent `AppModule` could also be crafted by hand using the `NgModule` decorator:
+ *
+ * ```
+ * var homeState = { name: 'home', url: '/home', component: Home };
+ * var aboutState = { name: 'about', url: '/about', component: About };
+ *
+ * @NgModule({
+ *   imports: [BrowserModule, UIRouterRootModule],
+ *   declarations: [NonRoutedComponent, Home, About],
+ *   entryComponents: [Home, About],
+ *   providers: [
+ *    { provide: UIROUTER_STATES_TOKEN, useValue: [homeState, aboutState], multi: true }
+ *   ]
+ * }) export class AppModule {};
+ *
+ * ```
  * 
  * @param moduleMetaData the [[UIRouterModuleMetadata]] 
  *        (See also [NgModuleMetadataType](https://angular.io/docs/ts/latest/api/core/index/NgModuleMetadataType-interface.html)