docs(Transition): Document UrlRouter as internal API

Relates to angular-ui/ui-router#3262 (comment)
ui-router · Jan 13, 2017 · fc571a2 · fc571a2
1 parent c211b60
commit fc571a2
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/url/urlRouter.ts b/src/url/urlRouter.ts
@@ -51,6 +51,10 @@ defaultRuleSortFn = composeSort(
 /**
  * Updates URL and responds to URL changes
  *
+ * ### Deprecation warning:
+ * This class is now considered to be an internal API
+ * For configuring URL rules, use the [[UrlRulesApi]] which can be found on [[UrlService.rules]].
+ *
  * This class updates the URL when the state changes.
  * It also responds to changes in the URL.
  */