docs(UrlService): Document url service API

fix(UrlService): Wire urlMatcherFactory and urlRouter functions
ui-router · Dec 30, 2016 · a7b58d6 · a7b58d6
1 parent eb2f5d7
commit a7b58d6
Show file tree

Hide file tree

Showing 9 changed files with 459 additions and 318 deletions.
diff --git a/src/common/coreservices.ts b/src/common/coreservices.ts
@@ -169,9 +169,9 @@ export interface LocationConfig extends Disposable {
   hashPrefix(newprefix: string): string;
 }
 
+/** @hidden */
 export interface TemplateServices {
   get(url: string): Promise<string>;
 }
 
-
 export {services};
diff --git a/src/params/interface.ts b/src/params/interface.ts
@@ -2,6 +2,7 @@
  * @coreapi
  * @module params
  */ /** for typedoc */
+
 import {ParamType} from "./type";
 
 /**
@@ -16,11 +17,14 @@ import {ParamType} from "./type";
  *   folderId: 'inbox'
  * }
  * ```
+ *
+ * @coreapi
  */
 export interface RawParams {
   [key: string]: any;
 }
 
+/** @internalapi */
 export type ParamsOrArray = (RawParams|RawParams[]);
 
 /**
@@ -53,6 +57,7 @@ export type ParamsOrArray = (RawParams|RawParams[]);
  *   }
  * }
  * ```
+ * @coreapi
  */
 export interface ParamDeclaration {
   /**
@@ -291,6 +296,7 @@ export interface ParamDeclaration {
   raw: boolean;
 }
 
+/** @internalapi */
 export interface Replace {
   from: string;
   to: string;
@@ -402,7 +408,8 @@ export interface Replace {
  * $state.go('list', { item: "Ringo" });
  * ```
  * 
- * See: [[UrlMatcherFactory.type]]
+ * See: [[UrlConfig.type]]
+ * @coreapi
  */
 export interface ParamTypeDefinition {
   /**

diff --git a/src/url/index.ts b/src/url/index.ts
@@ -7,3 +7,4 @@ export * from "./urlMatcher";
 export * from "./urlMatcherFactory";
 export * from "./urlRouter";
 export * from "./urlRule";
+export * from "./urlService";