@@ -103,10 +103,13 @@ function $RouteProvider() {
103
103
* {@link ngRoute.$route#$routeChangeError $routeChangeError} event is fired.
104
104
* For easier access to the resolved dependencies from the template, the `resolve` map will
105
105
* be available on the scope of the route, under `$resolve` (by default) or a custom name
106
- * specified by the `resolveAs` property (see below).
107
- * **Note:** If your scope already contains a property with this name, it will be hidden or
108
- * overwritten. Make sure, you specify an appropriate name for this property, that
109
- * does not collide with other properties on the scope.
106
+ * specified by the `resolveAs` property (see below). This can be particularly useful, when
107
+ * working with {@link angular.Module#component components} as route templates.<br />
108
+ * <div class="alert alert-warning">
109
+ * **Note:** If your scope already contains a property with this name, it will be hidden
110
+ * or overwritten. Make sure, you specify an appropriate name for this property, that
111
+ * does not collide with other properties on the scope.
112
+ * </div>
110
113
* The map object is:
111
114
*
112
115
* - `key` – `{string}`: a name of a dependency to be injected into the controller.
@@ -117,10 +120,10 @@ function $RouteProvider() {
117
120
* `ngRoute.$routeParams` will still refer to the previous route within these resolve
118
121
* functions. Use `$route.current.params` to access the new route parameters, instead.
119
122
*
120
- * - `resolveAs` - {string=} - The name under which the `resolve` map will be available on the
121
- * scope of the route. If omitted, defaults to `$resolve`.
123
+ * - `resolveAs` - ` {string=}` - The name under which the `resolve` map will be available on
124
+ * the scope of the route. If omitted, defaults to `$resolve`.
122
125
*
123
- * - `redirectTo` – {(string|function())=} – value to update
126
+ * - `redirectTo` – ` {(string|function())=}` – value to update
124
127
* {@link ng.$location $location} path with and trigger route redirection.
125
128
*
126
129
* If `redirectTo` is a function, it will be called with the following parameters:
@@ -133,13 +136,13 @@ function $RouteProvider() {
133
136
* The custom `redirectTo` function is expected to return a string which will be used
134
137
* to update `$location.path()` and `$location.search()`.
135
138
*
136
- * - `[reloadOnSearch=true]` - {boolean=} - reload route when only `$location.search()`
139
+ * - `[reloadOnSearch=true]` - ` {boolean=}` - reload route when only `$location.search()`
137
140
* or `$location.hash()` changes.
138
141
*
139
142
* If the option is set to `false` and url in the browser changes, then
140
143
* `$routeUpdate` event is broadcasted on the root scope.
141
144
*
142
- * - `[caseInsensitiveMatch=false]` - {boolean=} - match routes without being case sensitive
145
+ * - `[caseInsensitiveMatch=false]` - ` {boolean=}` - match routes without being case sensitive
143
146
*
144
147
* If the option is set to `true`, then the particular route can be matched without being
145
148
* case sensitive
@@ -278,7 +281,8 @@ function $RouteProvider() {
278
281
* - `$template` - The current route template HTML.
279
282
*
280
283
* The `locals` will be assigned to the route scope's `$resolve` property. You can override
281
- * the property name, using `resolveAs` in the route definition.
284
+ * the property name, using `resolveAs` in the route definition. See
285
+ * {@link ngRoute.$routeProvider $routeProvider} for more info.
282
286
*
283
287
* @property {Object } routes Object with all route configuration Objects as its properties.
284
288
*
0 commit comments