docs: remove all deprecated @stable
jsdoc tags (#23210)
These are no longer needed as stable docs are computed as those that do not have `@experimental` or `@deprecated` tags. PR Close #23210
This commit is contained in:

committed by
Igor Minar

parent
ee145790d7
commit
4b96a58c5a
@ -251,7 +251,7 @@ import {UrlSegment, UrlSegmentGroup} from './url_tree';
|
||||
* Then it will extract the set of routes defined in that NgModule, and will transparently add
|
||||
* those routes to the main configuration.
|
||||
*
|
||||
* @stable use Routes
|
||||
* use Routes
|
||||
*/
|
||||
export type Routes = Route[];
|
||||
|
||||
@ -296,7 +296,7 @@ export type UrlMatcher = (segments: UrlSegment[], group: UrlSegmentGroup, route:
|
||||
* Represents the static data associated with a particular route.
|
||||
*
|
||||
* See `Routes` for more details.
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export type Data = {
|
||||
[name: string]: any
|
||||
@ -308,7 +308,7 @@ export type Data = {
|
||||
* Represents the resolved data associated with a particular route.
|
||||
*
|
||||
* See `Routes` for more details.
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export type ResolveData = {
|
||||
[name: string]: any
|
||||
@ -320,7 +320,7 @@ export type ResolveData = {
|
||||
* The type of `loadChildren`.
|
||||
*
|
||||
* See `Routes` for more details.
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export type LoadChildrenCallback = () =>
|
||||
Type<any>| NgModuleFactory<any>| Promise<Type<any>>| Observable<Type<any>>;
|
||||
@ -331,7 +331,7 @@ export type LoadChildrenCallback = () =>
|
||||
* The type of `loadChildren`.
|
||||
*
|
||||
* See `Routes` for more details.
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export type LoadChildren = string | LoadChildrenCallback;
|
||||
|
||||
@ -341,7 +341,7 @@ export type LoadChildren = string | LoadChildrenCallback;
|
||||
* The type of `queryParamsHandling`.
|
||||
*
|
||||
* See `RouterLink` for more details.
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export type QueryParamsHandling = 'merge' | 'preserve' | '';
|
||||
|
||||
@ -357,7 +357,7 @@ export type RunGuardsAndResolvers = 'paramsChange' | 'paramsOrQueryParamsChange'
|
||||
|
||||
/**
|
||||
* See `Routes` for more details.
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export interface Route {
|
||||
path?: string;
|
||||
|
@ -88,7 +88,7 @@ import {UrlTree} from '../url_tree';
|
||||
*
|
||||
* @ngModule RouterModule
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
@Directive({selector: ':not(a)[routerLink]'})
|
||||
export class RouterLink {
|
||||
@ -160,7 +160,7 @@ export class RouterLink {
|
||||
*
|
||||
* @ngModule RouterModule
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
@Directive({selector: 'a[routerLink]'})
|
||||
export class RouterLinkWithHref implements OnChanges, OnDestroy {
|
||||
|
@ -70,7 +70,7 @@ import {RouterLink, RouterLinkWithHref} from './router_link';
|
||||
*
|
||||
* @ngModule RouterModule
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
@Directive({
|
||||
selector: '[routerLinkActive]',
|
||||
|
@ -33,7 +33,7 @@ import {PRIMARY_OUTLET} from '../shared';
|
||||
* ```
|
||||
* @ngModule RouterModule
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
@Directive({selector: 'router-outlet', exportAs: 'outlet'})
|
||||
export class RouterOutlet implements OnDestroy, OnInit {
|
||||
|
@ -55,7 +55,7 @@ export class RouterEvent {
|
||||
*
|
||||
* Represents an event triggered when a navigation starts.
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export class NavigationStart extends RouterEvent {
|
||||
/**
|
||||
@ -104,7 +104,7 @@ export class NavigationStart extends RouterEvent {
|
||||
*
|
||||
* Represents an event triggered when a navigation ends successfully.
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export class NavigationEnd extends RouterEvent {
|
||||
constructor(
|
||||
@ -128,7 +128,7 @@ export class NavigationEnd extends RouterEvent {
|
||||
*
|
||||
* Represents an event triggered when a navigation is canceled.
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export class NavigationCancel extends RouterEvent {
|
||||
constructor(
|
||||
@ -150,7 +150,7 @@ export class NavigationCancel extends RouterEvent {
|
||||
*
|
||||
* Represents an event triggered when a navigation fails due to an unexpected error.
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export class NavigationError extends RouterEvent {
|
||||
constructor(
|
||||
@ -174,7 +174,7 @@ export class NavigationError extends RouterEvent {
|
||||
*
|
||||
* Represents an event triggered when routes are recognized.
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export class RoutesRecognized extends RouterEvent {
|
||||
constructor(
|
||||
@ -424,7 +424,7 @@ export class ActivationEnd {
|
||||
* - `NavigationCancel`,
|
||||
* - `NavigationError`
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export type Event = RouterEvent | RouteConfigLoadStart | RouteConfigLoadEnd | ChildActivationStart |
|
||||
ChildActivationEnd | ActivationStart | ActivationEnd;
|
||||
|
@ -75,7 +75,7 @@ import {ActivatedRouteSnapshot, RouterStateSnapshot} from './router_state';
|
||||
* class AppModule {}
|
||||
* ```
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export interface CanActivate {
|
||||
canActivate(route: ActivatedRouteSnapshot, state: RouterStateSnapshot):
|
||||
@ -155,7 +155,7 @@ export interface CanActivate {
|
||||
* class AppModule {}
|
||||
* ```
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export interface CanActivateChild {
|
||||
canActivateChild(childRoute: ActivatedRouteSnapshot, state: RouterStateSnapshot):
|
||||
@ -228,7 +228,7 @@ export interface CanActivateChild {
|
||||
* class AppModule {}
|
||||
* ```
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export interface CanDeactivate<T> {
|
||||
canDeactivate(
|
||||
@ -301,7 +301,7 @@ export interface CanDeactivate<T> {
|
||||
* })
|
||||
* class AppModule {}
|
||||
* ```
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export interface Resolve<T> {
|
||||
resolve(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable<T>|Promise<T>|T;
|
||||
@ -370,6 +370,6 @@ export interface Resolve<T> {
|
||||
* class AppModule {}
|
||||
* ```
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export interface CanLoad { canLoad(route: Route): Observable<boolean>|Promise<boolean>|boolean; }
|
||||
|
@ -34,7 +34,7 @@ import {TreeNode, nodeChildrenAsMap} from './utils/tree';
|
||||
*
|
||||
* Represents the extra options used during navigation.
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export interface NavigationExtras {
|
||||
/**
|
||||
@ -152,7 +152,7 @@ export interface NavigationExtras {
|
||||
* If the handler throws an exception, the navigation promise will be rejected with
|
||||
* the exception.
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export type ErrorHandler = (error: any) => any;
|
||||
|
||||
@ -195,7 +195,7 @@ function defaultRouterHook(snapshot: RouterStateSnapshot): Observable<void> {
|
||||
*
|
||||
* @ngModule RouterModule
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export class Router {
|
||||
private currentUrlTree: UrlTree;
|
||||
|
@ -33,7 +33,7 @@ import {flatten} from './utils/collection';
|
||||
*
|
||||
* Contains a list of directives
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
const ROUTER_DIRECTIVES = [RouterOutlet, RouterLink, RouterLinkWithHref, RouterLinkActive];
|
||||
|
||||
@ -42,7 +42,7 @@ const ROUTER_DIRECTIVES = [RouterOutlet, RouterLink, RouterLinkWithHref, RouterL
|
||||
*
|
||||
* Is used in DI to configure the router.
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export const ROUTER_CONFIGURATION = new InjectionToken<ExtraOptions>('ROUTER_CONFIGURATION');
|
||||
|
||||
@ -125,7 +125,7 @@ export function routerNgProbeToken() {
|
||||
* [Read this developer guide](https://angular.io/docs/ts/latest/guide/router.html) to get an
|
||||
* overview of how the router should be used.
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
@NgModule({declarations: ROUTER_DIRECTIVES, exports: ROUTER_DIRECTIVES})
|
||||
export class RouterModule {
|
||||
@ -213,7 +213,7 @@ export function provideForRootGuard(router: Router): any {
|
||||
* class MyNgModule {}
|
||||
* ```
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export function provideRoutes(routes: Routes): any {
|
||||
return [
|
||||
@ -255,7 +255,7 @@ export type InitialNavigation =
|
||||
*
|
||||
* Represents options to configure the router.
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export interface ExtraOptions {
|
||||
/**
|
||||
|
@ -15,7 +15,7 @@ import {ActivatedRoute} from './router_state';
|
||||
/**
|
||||
* Store contextual information about a `RouterOutlet`
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export class OutletContext {
|
||||
outlet: RouterOutlet|null = null;
|
||||
@ -28,7 +28,7 @@ export class OutletContext {
|
||||
/**
|
||||
* Store contextual information about the children (= nested) `RouterOutlet`
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export class ChildrenOutletContexts {
|
||||
// contexts for child outlets, by name.
|
||||
|
@ -67,7 +67,7 @@ export class NoPreloading implements PreloadingStrategy {
|
||||
*
|
||||
* If a route is protected by `canLoad` guards, the preloaded will not load it.
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
@Injectable()
|
||||
export class RouterPreloader implements OnDestroy {
|
||||
|
@ -43,7 +43,7 @@ import {Tree, TreeNode} from './utils/tree';
|
||||
*
|
||||
* See `ActivatedRoute` for more information.
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export class RouterState extends Tree<ActivatedRoute> {
|
||||
/** @internal */
|
||||
@ -102,7 +102,7 @@ export function createEmptyStateSnapshot(
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export class ActivatedRoute {
|
||||
/** The current snapshot of this route */
|
||||
@ -245,7 +245,7 @@ function flattenInherited(pathFromRoot: ActivatedRouteSnapshot[]): Inherited {
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export class ActivatedRouteSnapshot {
|
||||
/** The configuration used to match this route **/
|
||||
@ -348,7 +348,7 @@ export class ActivatedRouteSnapshot {
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export class RouterStateSnapshot extends Tree<ActivatedRouteSnapshot> {
|
||||
/** @internal */
|
||||
|
@ -15,14 +15,14 @@ import {UrlSegment, UrlSegmentGroup} from './url_tree';
|
||||
*
|
||||
* Name of the primary outlet.
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export const PRIMARY_OUTLET = 'primary';
|
||||
|
||||
/**
|
||||
* A collection of parameters.
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export type Params = {
|
||||
[key: string]: any
|
||||
@ -38,7 +38,7 @@ export type Params = {
|
||||
* The API is inspired by the URLSearchParams interface.
|
||||
* see https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export interface ParamMap {
|
||||
has(name: string): boolean;
|
||||
@ -91,7 +91,7 @@ class ParamsAsMap implements ParamMap {
|
||||
/**
|
||||
* Convert a `Params` instance to a `ParamMap`.
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export function convertToParamMap(params: Params): ParamMap {
|
||||
return new ParamsAsMap(params);
|
||||
|
@ -100,7 +100,7 @@ function containsSegmentGroupHelper(
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export class UrlTree {
|
||||
/** @internal */
|
||||
@ -133,7 +133,7 @@ export class UrlTree {
|
||||
*
|
||||
* See `UrlTree` for more information.
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export class UrlSegmentGroup {
|
||||
/** @internal */
|
||||
@ -185,7 +185,7 @@ export class UrlSegmentGroup {
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export class UrlSegment {
|
||||
/** @internal */
|
||||
@ -245,7 +245,7 @@ export function mapChildrenIntoArray<T>(
|
||||
*
|
||||
* See `DefaultUrlSerializer` for an example of a URL serializer.
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export abstract class UrlSerializer {
|
||||
/** Parse a url into a `UrlTree` */
|
||||
@ -271,7 +271,7 @@ export abstract class UrlSerializer {
|
||||
* colon syntax to specify the outlet, and the ';parameter=value' syntax (e.g., open=true) to
|
||||
* specify route specific parameters.
|
||||
*
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export class DefaultUrlSerializer implements UrlSerializer {
|
||||
/** Parses a url into a `UrlTree` */
|
||||
|
@ -14,6 +14,6 @@
|
||||
|
||||
import {Version} from '@angular/core';
|
||||
/**
|
||||
* @stable
|
||||
*
|
||||
*/
|
||||
export const VERSION = new Version('0.0.0-PLACEHOLDER');
|
||||
|
Reference in New Issue
Block a user