Skip to content

Commit 9141424

Browse files
petebacondarwinIgorMinar
petebacondarwin
authored and
IgorMinar
committed
docs(router): remove unnecessary {@link Injector} jsdoc tags (angular#23187)
Inline code blocks are automatically linked, if possible, to their API page. PR Close angular#23187
1 parent 31b9043 commit 9141424

10 files changed

Lines changed: 55 additions & 55 deletions

File tree

‎packages/router/src/config.ts‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,21 @@ import {UrlSegment, UrlSegmentGroup} from './url_tree';
2525
* - `redirectTo` is the url fragment which will replace the current matched segment.
2626
* - `outlet` is the name of the outlet the component should be placed into.
2727
* - `canActivate` is an array of DI tokens used to look up CanActivate handlers. See
28-
* {@link CanActivate} for more info.
28+
* `CanActivate` for more info.
2929
* - `canActivateChild` is an array of DI tokens used to look up CanActivateChild handlers. See
30-
* {@link CanActivateChild} for more info.
30+
* `CanActivateChild` for more info.
3131
* - `canDeactivate` is an array of DI tokens used to look up CanDeactivate handlers. See
32-
* {@link CanDeactivate} for more info.
32+
* `CanDeactivate` for more info.
3333
* - `canLoad` is an array of DI tokens used to look up CanLoad handlers. See
34-
* {@link CanLoad} for more info.
34+
* `CanLoad` for more info.
3535
* - `data` is additional data provided to the component via `ActivatedRoute`.
36-
* - `resolve` is a map of DI tokens used to look up data resolvers. See {@link Resolve} for more
36+
* - `resolve` is a map of DI tokens used to look up data resolvers. See `Resolve` for more
3737
* info.
3838
* - `runGuardsAndResolvers` defines when guards and resolvers will be run. By default they run only
3939
* when the matrix parameters of the route change. When set to `paramsOrQueryParamsChange` they
4040
* will also run when query params change. And when set to `always`, they will run every time.
4141
* - `children` is an array of child route definitions.
42-
* - `loadChildren` is a reference to lazy loaded child routes. See {@link LoadChildren} for more
42+
* - `loadChildren` is a reference to lazy loaded child routes. See `LoadChildren` for more
4343
* info.
4444
*
4545
* ### Simple Configuration
@@ -295,7 +295,7 @@ export type UrlMatcher = (segments: UrlSegment[], group: UrlSegmentGroup, route:
295295
*
296296
* Represents the static data associated with a particular route.
297297
*
298-
* See {@link Routes} for more details.
298+
* See `Routes` for more details.
299299
* @stable
300300
*/
301301
export type Data = {
@@ -307,7 +307,7 @@ export type Data = {
307307
*
308308
* Represents the resolved data associated with a particular route.
309309
*
310-
* See {@link Routes} for more details.
310+
* See `Routes` for more details.
311311
* @stable
312312
*/
313313
export type ResolveData = {
@@ -319,7 +319,7 @@ export type ResolveData = {
319319
*
320320
* The type of `loadChildren`.
321321
*
322-
* See {@link Routes} for more details.
322+
* See `Routes` for more details.
323323
* @stable
324324
*/
325325
export type LoadChildrenCallback = () =>
@@ -330,7 +330,7 @@ export type LoadChildrenCallback = () =>
330330
*
331331
* The type of `loadChildren`.
332332
*
333-
* See {@link Routes} for more details.
333+
* See `Routes` for more details.
334334
* @stable
335335
*/
336336
export type LoadChildren = string | LoadChildrenCallback;
@@ -340,7 +340,7 @@ export type LoadChildren = string | LoadChildrenCallback;
340340
*
341341
* The type of `queryParamsHandling`.
342342
*
343-
* See {@link RouterLink} for more details.
343+
* See `RouterLink` for more details.
344344
* @stable
345345
*/
346346
export type QueryParamsHandling = 'merge' | 'preserve' | '';
@@ -350,13 +350,13 @@ export type QueryParamsHandling = 'merge' | 'preserve' | '';
350350
*
351351
* The type of `runGuardsAndResolvers`.
352352
*
353-
* See {@link Routes} for more details.
353+
* See `Routes` for more details.
354354
* @experimental
355355
*/
356356
export type RunGuardsAndResolvers = 'paramsChange' | 'paramsOrQueryParamsChange' | 'always';
357357

358358
/**
359-
* See {@link Routes} for more details.
359+
* See `Routes` for more details.
360360
* @stable
361361
*/
362362
export interface Route {

‎packages/router/src/directives/router_link.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ export class RouterLink {
156156
*
157157
* Lets you link to specific routes in your app.
158158
*
159-
* See {@link RouterLink} for more information.
159+
* See `RouterLink` for more information.
160160
*
161161
* @ngModule RouterModule
162162
*

‎packages/router/src/events.ts‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ export class ResolveStart extends RouterEvent {
279279
* @description
280280
*
281281
* Represents the end of the Resolve phase of routing. See note on
282-
* {@link ResolveStart} for use of this experimental API.
282+
* `ResolveStart` for use of this experimental API.
283283
*
284284
* @experimental
285285
*/
@@ -333,7 +333,7 @@ export class RouteConfigLoadEnd {
333333
* @description
334334
*
335335
* Represents the start of end of the Resolve phase of routing. See note on
336-
* {@link ChildActivationEnd} for use of this experimental API.
336+
* `ChildActivationEnd` for use of this experimental API.
337337
*
338338
* @experimental
339339
*/
@@ -351,7 +351,7 @@ export class ChildActivationStart {
351351
* @description
352352
*
353353
* Represents the start of end of the Resolve phase of routing. See note on
354-
* {@link ChildActivationStart} for use of this experimental API.
354+
* `ChildActivationStart` for use of this experimental API.
355355
*
356356
* @experimental
357357
*/
@@ -369,7 +369,7 @@ export class ChildActivationEnd {
369369
* @description
370370
*
371371
* Represents the start of end of the Resolve phase of routing. See note on
372-
* {@link ActivationEnd} for use of this experimental API.
372+
* `ActivationEnd` for use of this experimental API.
373373
*
374374
* @experimental
375375
*/
@@ -387,7 +387,7 @@ export class ActivationStart {
387387
* @description
388388
*
389389
* Represents the start of end of the Resolve phase of routing. See note on
390-
* {@link ActivationStart} for use of this experimental API.
390+
* `ActivationStart` for use of this experimental API.
391391
*
392392
* @experimental
393393
*/
@@ -408,21 +408,21 @@ export class ActivationEnd {
408408
*
409409
* The sequence of router events is:
410410
*
411-
* - {@link NavigationStart},
412-
* - {@link RouteConfigLoadStart},
413-
* - {@link RouteConfigLoadEnd},
414-
* - {@link RoutesRecognized},
415-
* - {@link GuardsCheckStart},
416-
* - {@link ChildActivationStart},
417-
* - {@link ActivationStart},
418-
* - {@link GuardsCheckEnd},
419-
* - {@link ResolveStart},
420-
* - {@link ResolveEnd},
421-
* - {@link ActivationEnd}
422-
* - {@link ChildActivationEnd}
423-
* - {@link NavigationEnd},
424-
* - {@link NavigationCancel},
425-
* - {@link NavigationError}
411+
* - `NavigationStart`,
412+
* - `RouteConfigLoadStart`,
413+
* - `RouteConfigLoadEnd`,
414+
* - `RoutesRecognized`,
415+
* - `GuardsCheckStart`,
416+
* - `ChildActivationStart`,
417+
* - `ActivationStart`,
418+
* - `GuardsCheckEnd`,
419+
* - `ResolveStart`,
420+
* - `ResolveEnd`,
421+
* - `ActivationEnd`
422+
* - `ChildActivationEnd`
423+
* - `NavigationEnd`,
424+
* - `NavigationCancel`,
425+
* - `NavigationError`
426426
*
427427
* @stable
428428
*/

‎packages/router/src/router.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ function defaultRouterHook(snapshot: RouterStateSnapshot): Observable<void> {
191191
*
192192
* Provides the navigation and url manipulation capabilities.
193193
*
194-
* See {@link Routes} for more details and examples.
194+
* See `Routes` for more details and examples.
195195
*
196196
* @ngModule RouterModule
197197
*
@@ -213,7 +213,7 @@ export class Router {
213213
/**
214214
* Error handler that is invoked when a navigation errors.
215215
*
216-
* See {@link ErrorHandler} for more information.
216+
* See `ErrorHandler` for more information.
217217
*/
218218
errorHandler: ErrorHandler = defaultErrorHandler;
219219

@@ -486,10 +486,10 @@ export class Router {
486486
return this.navigateByUrl(this.createUrlTree(commands, extras), extras);
487487
}
488488

489-
/** Serializes a {@link UrlTree} into a string */
489+
/** Serializes a `UrlTree` into a string */
490490
serializeUrl(url: UrlTree): string { return this.urlSerializer.serialize(url); }
491491

492-
/** Parses a string into a {@link UrlTree} */
492+
/** Parses a string into a `UrlTree` */
493493
parseUrl(url: string): UrlTree { return this.urlSerializer.parse(url); }
494494

495495
/** Returns whether the url is activated */

‎packages/router/src/router_module.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -136,15 +136,15 @@ export class RouterModule {
136136
* Creates a module with all the router providers and directives. It also optionally sets up an
137137
* application listener to perform an initial navigation.
138138
*
139-
* Options (see {@link ExtraOptions}):
139+
* Options (see `ExtraOptions`):
140140
* * `enableTracing` makes the router log all its internal events to the console.
141141
* * `useHash` enables the location strategy that uses the URL fragment instead of the history
142142
* API.
143143
* * `initialNavigation` disables the initial navigation.
144144
* * `errorHandler` provides a custom error handler.
145-
* * `preloadingStrategy` configures a preloading strategy (see {@link PreloadAllModules}).
145+
* * `preloadingStrategy` configures a preloading strategy (see `PreloadAllModules`).
146146
* * `onSameUrlNavigation` configures how the router handles navigation to the current URL. See
147-
* {@link ExtraOptions} for more details.
147+
* `ExtraOptions` for more details.
148148
*/
149149
static forRoot(routes: Routes, config?: ExtraOptions): ModuleWithProviders {
150150
return {
@@ -279,7 +279,7 @@ export interface ExtraOptions {
279279
errorHandler?: ErrorHandler;
280280

281281
/**
282-
* Configures a preloading strategy. See {@link PreloadAllModules}.
282+
* Configures a preloading strategy. See `PreloadAllModules`.
283283
*/
284284
preloadingStrategy?: any;
285285

‎packages/router/src/router_outlet_context.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import {ActivatedRoute} from './router_state';
1313

1414

1515
/**
16-
* Store contextual information about a {@link RouterOutlet}
16+
* Store contextual information about a `RouterOutlet`
1717
*
1818
* @stable
1919
*/
@@ -26,7 +26,7 @@ export class OutletContext {
2626
}
2727

2828
/**
29-
* Store contextual information about the children (= nested) {@link RouterOutlet}
29+
* Store contextual information about the children (= nested) `RouterOutlet`
3030
*
3131
* @stable
3232
*/

‎packages/router/src/router_state.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ import {Tree, TreeNode} from './utils/tree';
4141
* }
4242
* ```
4343
*
44-
* See {@link ActivatedRoute} for more information.
44+
* See `ActivatedRoute` for more information.
4545
*
4646
* @stable
4747
*/

‎packages/router/src/shared.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ class ParamsAsMap implements ParamMap {
8989
}
9090

9191
/**
92-
* Convert a {@link Params} instance to a {@link ParamMap}.
92+
* Convert a `Params` instance to a `ParamMap`.
9393
*
9494
* @stable
9595
*/

‎packages/router/src/url_tree.ts‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ export class UrlTree {
131131
*
132132
* Represents the parsed URL segment group.
133133
*
134-
* See {@link UrlTree} for more information.
134+
* See `UrlTree` for more information.
135135
*
136136
* @stable
137137
*/
@@ -144,7 +144,7 @@ export class UrlSegmentGroup {
144144
parent: UrlSegmentGroup|null = null;
145145

146146
constructor(
147-
/** The URL segments of this group. See {@link UrlSegment} for more information */
147+
/** The URL segments of this group. See `UrlSegment` for more information */
148148
public segments: UrlSegment[],
149149
/** The list of children of this group */
150150
public children: {[key: string]: UrlSegmentGroup}) {
@@ -243,22 +243,22 @@ export function mapChildrenIntoArray<T>(
243243
* The url serialization strategy is customizable. You can
244244
* make all URLs case insensitive by providing a custom UrlSerializer.
245245
*
246-
* See {@link DefaultUrlSerializer} for an example of a URL serializer.
246+
* See `DefaultUrlSerializer` for an example of a URL serializer.
247247
*
248248
* @stable
249249
*/
250250
export abstract class UrlSerializer {
251-
/** Parse a url into a {@link UrlTree} */
251+
/** Parse a url into a `UrlTree` */
252252
abstract parse(url: string): UrlTree;
253253

254-
/** Converts a {@link UrlTree} into a url */
254+
/** Converts a `UrlTree` into a url */
255255
abstract serialize(tree: UrlTree): string;
256256
}
257257

258258
/**
259259
* @description
260260
*
261-
* A default implementation of the {@link UrlSerializer}.
261+
* A default implementation of the `UrlSerializer`.
262262
*
263263
* Example URLs:
264264
*
@@ -274,13 +274,13 @@ export abstract class UrlSerializer {
274274
* @stable
275275
*/
276276
export class DefaultUrlSerializer implements UrlSerializer {
277-
/** Parses a url into a {@link UrlTree} */
277+
/** Parses a url into a `UrlTree` */
278278
parse(url: string): UrlTree {
279279
const p = new UrlParser(url);
280280
return new UrlTree(p.parseRootSegment(), p.parseQueryParams(), p.parseFragment());
281281
}
282282

283-
/** Converts a {@link UrlTree} into a url */
283+
/** Converts a `UrlTree` into a url */
284284
serialize(tree: UrlTree): string {
285285
const segment = `/${serializeSegment(tree.root, true)}`;
286286
const query = serializeQueryParams(tree.queryParams);

‎packages/router/testing/src/router_testing_module.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ export function setupTestingRouter(
136136
* Sets up the router to be used for testing.
137137
*
138138
* The modules sets up the router to be used for testing.
139-
* It provides spy implementations of {@link Location}, {@link LocationStrategy}, and {@link
139+
* It provides spy implementations of `Location`, `LocationStrategy`, and {@link
140140
* NgModuleFactoryLoader}.
141141
*
142142
* ### Example

0 commit comments

Comments
 (0)