Skip to content

Commit 4b96a58

Browse files
petebacondarwinIgorMinar
authored andcommitted
docs: remove all deprecated @stable jsdoc tags (angular#23210)
These are no longer needed as stable docs are computed as those that do not have `@experimental` or `@deprecated` tags. PR Close angular#23210
1 parent ee14579 commit 4b96a58

File tree

155 files changed

+363
-643
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

155 files changed

+363
-643
lines changed

packages/animations/src/version.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
/**
1616
* @whatItDoes Represents the version of angular/animations
1717
*
18-
* @stable
18+
*
1919
*/
2020
export class Version {
2121
public readonly major: string;
@@ -31,6 +31,6 @@ export class Version {
3131
}
3232

3333
/**
34-
* @stable
34+
*
3535
*/
3636
export const VERSION = new Version('0.0.0-PLACEHOLDER');

packages/common/http/src/backend.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import {HttpEvent} from './response';
2020
*
2121
* In an `HttpInterceptor`, the `HttpHandler` parameter is the next interceptor in the chain.
2222
*
23-
* @stable
23+
*
2424
*/
2525
export abstract class HttpHandler {
2626
abstract handle(req: HttpRequest<any>): Observable<HttpEvent<any>>;
@@ -34,7 +34,7 @@ export abstract class HttpHandler {
3434
* When injected, `HttpBackend` dispatches requests directly to the backend, without going
3535
* through the interceptor chain.
3636
*
37-
* @stable
37+
*
3838
*/
3939
export abstract class HttpBackend implements HttpHandler {
4040
abstract handle(req: HttpRequest<any>): Observable<HttpEvent<any>>;

packages/common/http/src/client.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ function addBody<T>(
4343
}
4444

4545
/**
46-
* @stable
46+
*
4747
*/
4848
export type HttpObserve = 'body' | 'events' | 'response';
4949

@@ -54,7 +54,7 @@ export type HttpObserve = 'body' | 'events' | 'response';
5454
* Each request method has multiple signatures, and the return type varies according to which
5555
* signature is called (mainly the values of `observe` and `responseType`).
5656
*
57-
* @stable
57+
*
5858
*/
5959
@Injectable()
6060
export class HttpClient {

packages/common/http/src/headers.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ interface Update {
1414

1515
/**
1616
* Immutable set of Http headers, with lazy parsing.
17-
* @stable
17+
*
1818
*/
1919
export class HttpHeaders {
2020
/**

packages/common/http/src/interceptor.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import {HttpEvent} from './response';
2222
* In rare cases, interceptors may wish to completely handle a request themselves,
2323
* and not delegate to the remainder of the chain. This behavior is allowed.
2424
*
25-
* @stable
25+
*
2626
*/
2727
export interface HttpInterceptor {
2828
/**
@@ -47,7 +47,7 @@ export interface HttpInterceptor {
4747
/**
4848
* `HttpHandler` which applies an `HttpInterceptor` to an `HttpRequest`.
4949
*
50-
* @stable
50+
*
5151
*/
5252
export class HttpInterceptorHandler implements HttpHandler {
5353
constructor(private next: HttpHandler, private interceptor: HttpInterceptor) {}
@@ -61,7 +61,7 @@ export class HttpInterceptorHandler implements HttpHandler {
6161
* A multi-provider token which represents the array of `HttpInterceptor`s that
6262
* are registered.
6363
*
64-
* @stable
64+
*
6565
*/
6666
export const HTTP_INTERCEPTORS = new InjectionToken<HttpInterceptor[]>('HTTP_INTERCEPTORS');
6767

packages/common/http/src/jsonp.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,15 @@ export const JSONP_ERR_WRONG_RESPONSE_TYPE = 'JSONP requests must use Json respo
3434
*
3535
* In the browser, this should always be the `window` object.
3636
*
37-
* @stable
37+
*
3838
*/
3939
export abstract class JsonpCallbackContext { [key: string]: (data: any) => void; }
4040

4141
/**
4242
* `HttpBackend` that only processes `HttpRequest` with the JSONP method,
4343
* by performing JSONP style requests.
4444
*
45-
* @stable
45+
*
4646
*/
4747
@Injectable()
4848
export class JsonpClientBackend implements HttpBackend {
@@ -206,7 +206,7 @@ export class JsonpClientBackend implements HttpBackend {
206206
* An `HttpInterceptor` which identifies requests with the method JSONP and
207207
* shifts them to the `JsonpClientBackend`.
208208
*
209-
* @stable
209+
*
210210
*/
211211
@Injectable()
212212
export class JsonpInterceptor {

packages/common/http/src/module.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ export class HttpInterceptingHandler implements HttpHandler {
4848
*
4949
* Meant to be used as a factory function within `HttpClientModule`.
5050
*
51-
* @stable
51+
*
5252
*/
5353
export function interceptingHandler(
5454
backend: HttpBackend, interceptors: HttpInterceptor[] | null = []): HttpHandler {
@@ -65,7 +65,7 @@ export function interceptingHandler(
6565
* Ordinarily JSONP callbacks are stored on the `window` object, but this may not exist
6666
* in test environments. In that case, callbacks are stored on an anonymous object instead.
6767
*
68-
* @stable
68+
*
6969
*/
7070
export function jsonpCallbackContext(): Object {
7171
if (typeof window === 'object') {
@@ -84,7 +84,7 @@ export function jsonpCallbackContext(): Object {
8484
* If no such names are provided, the default is to use `X-XSRF-TOKEN` for
8585
* the header name and `XSRF-TOKEN` for the cookie name.
8686
*
87-
* @stable
87+
*
8888
*/
8989
@NgModule({
9090
providers: [
@@ -132,7 +132,7 @@ export class HttpClientXsrfModule {
132132
* Interceptors can be added to the chain behind `HttpClient` by binding them
133133
* to the multiprovider for `HTTP_INTERCEPTORS`.
134134
*
135-
* @stable
135+
*
136136
*/
137137
@NgModule({
138138
imports: [
@@ -159,7 +159,7 @@ export class HttpClientModule {
159159
* Without this module, Jsonp requests will reach the backend
160160
* with method JSONP, where they'll be rejected.
161161
*
162-
* @stable
162+
*
163163
*/
164164
@NgModule({
165165
providers: [

packages/common/http/src/params.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
*
1212
* Used by `HttpParams`.
1313
*
14-
* @stable
14+
*
1515
**/
1616
export interface HttpParameterCodec {
1717
encodeKey(key: string): string;
@@ -25,7 +25,7 @@ export interface HttpParameterCodec {
2525
* A `HttpParameterCodec` that uses `encodeURIComponent` and `decodeURIComponent` to
2626
* serialize and parse URL parameter keys and values.
2727
*
28-
* @stable
28+
*
2929
*/
3030
export class HttpUrlEncodingCodec implements HttpParameterCodec {
3131
encodeKey(k: string): string { return standardEncoding(k); }
@@ -94,7 +94,7 @@ export interface HttpParamsOptions {
9494
*
9595
* This class is immutable - all mutation operations return a new instance.
9696
*
97-
* @stable
97+
*
9898
*/
9999
export class HttpParams {
100100
private map: Map<string, string[]>|null;

packages/common/http/src/request.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ function isFormData(value: any): value is FormData {
7373
* assumed to be immutable. To modify a `HttpRequest`, the `clone`
7474
* method should be used.
7575
*
76-
* @stable
76+
*
7777
*/
7878
export class HttpRequest<T> {
7979
/**

packages/common/http/src/response.ts

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import {HttpHeaders} from './headers';
1111
/**
1212
* Type enumeration for the different kinds of `HttpEvent`.
1313
*
14-
* @stable
14+
*
1515
*/
1616
export enum HttpEventType {
1717
/**
@@ -48,7 +48,7 @@ export enum HttpEventType {
4848
/**
4949
* Base interface for progress events.
5050
*
51-
* @stable
51+
*
5252
*/
5353
export interface HttpProgressEvent {
5454
/**
@@ -71,7 +71,7 @@ export interface HttpProgressEvent {
7171
/**
7272
* A download progress event.
7373
*
74-
* @stable
74+
*
7575
*/
7676
export interface HttpDownloadProgressEvent extends HttpProgressEvent {
7777
type: HttpEventType.DownloadProgress;
@@ -87,7 +87,7 @@ export interface HttpDownloadProgressEvent extends HttpProgressEvent {
8787
/**
8888
* An upload progress event.
8989
*
90-
* @stable
90+
*
9191
*/
9292
export interface HttpUploadProgressEvent extends HttpProgressEvent {
9393
type: HttpEventType.UploadProgress;
@@ -98,7 +98,7 @@ export interface HttpUploadProgressEvent extends HttpProgressEvent {
9898
* when a request may be retried multiple times, to distinguish between
9999
* retries on the final event stream.
100100
*
101-
* @stable
101+
*
102102
*/
103103
export interface HttpSentEvent { type: HttpEventType.Sent; }
104104

@@ -108,7 +108,7 @@ export interface HttpSentEvent { type: HttpEventType.Sent; }
108108
* Grouping all custom events under this type ensures they will be handled
109109
* and forwarded by all implementations of interceptors.
110110
*
111-
* @stable
111+
*
112112
*/
113113
export interface HttpUserEvent<T> { type: HttpEventType.User; }
114114

@@ -118,7 +118,7 @@ export interface HttpUserEvent<T> { type: HttpEventType.User; }
118118
*
119119
* It bundles the Error object with the actual response body that failed to parse.
120120
*
121-
* @stable
121+
*
122122
*/
123123
export interface HttpJsonParseError {
124124
error: Error;
@@ -130,15 +130,15 @@ export interface HttpJsonParseError {
130130
*
131131
* Typed according to the expected type of the response.
132132
*
133-
* @stable
133+
*
134134
*/
135135
export type HttpEvent<T> =
136136
HttpSentEvent | HttpHeaderResponse | HttpResponse<T>| HttpProgressEvent | HttpUserEvent<T>;
137137

138138
/**
139139
* Base class for both `HttpResponse` and `HttpHeaderResponse`.
140140
*
141-
* @stable
141+
*
142142
*/
143143
export abstract class HttpResponseBase {
144144
/**
@@ -206,7 +206,7 @@ export abstract class HttpResponseBase {
206206
* `HttpHeaderResponse` is a `HttpEvent` available on the response
207207
* event stream, only when progress events are requested.
208208
*
209-
* @stable
209+
*
210210
*/
211211
export class HttpHeaderResponse extends HttpResponseBase {
212212
/**
@@ -247,7 +247,7 @@ export class HttpHeaderResponse extends HttpResponseBase {
247247
* `HttpResponse` is a `HttpEvent` available on the response event
248248
* stream.
249249
*
250-
* @stable
250+
*
251251
*/
252252
export class HttpResponse<T> extends HttpResponseBase {
253253
/**
@@ -297,7 +297,7 @@ export class HttpResponse<T> extends HttpResponseBase {
297297
* will contain either a wrapped Error object or the error response returned
298298
* from the server.
299299
*
300-
* @stable
300+
*
301301
*/
302302
export class HttpErrorResponse extends HttpResponseBase implements Error {
303303
readonly name = 'HttpErrorResponse';

0 commit comments

Comments
 (0)