From fc571a2338bd3b25ad28df0eecb036459e7435ac Mon Sep 17 00:00:00 2001 From: Chris Thielen Date: Fri, 13 Jan 2017 13:07:22 -0600 Subject: [PATCH] docs(Transition): Document UrlRouter as internal API Relates to https://github.com/angular-ui/ui-router/issues/3262#issue-200530414 --- src/url/urlRouter.ts | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/url/urlRouter.ts b/src/url/urlRouter.ts index 73fa467e..24f793df 100644 --- 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. */