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
angular · Apr 11, 2018 · 4b96a58 · 4b96a58
1 parent ee14579
commit 4b96a58
Show file tree

Hide file tree

Showing 155 changed files with 363 additions and 643 deletions.
diff --git a/packages/animations/src/version.ts b/packages/animations/src/version.ts
@@ -15,7 +15,7 @@
 /**
  * @whatItDoes Represents the version of angular/animations
  *
- * @stable
+ *
  */
 export class Version {
   public readonly major: string;
@@ -31,6 +31,6 @@ export class Version {
 }
 
 /**
- * @stable
+ *
  */
 export const VERSION = new Version('0.0.0-PLACEHOLDER');
diff --git a/packages/common/http/src/backend.ts b/packages/common/http/src/backend.ts
@@ -20,7 +20,7 @@ import {HttpEvent} from './response';
  *
  * In an `HttpInterceptor`, the `HttpHandler` parameter is the next interceptor in the chain.
  *
- * @stable
+ *
  */
 export abstract class HttpHandler {
   abstract handle(req: HttpRequest<any>): Observable<HttpEvent<any>>;
@@ -34,7 +34,7 @@ export abstract class HttpHandler {
  * When injected, `HttpBackend` dispatches requests directly to the backend, without going
  * through the interceptor chain.
  *
- * @stable
+ *
  */
 export abstract class HttpBackend implements HttpHandler {
   abstract handle(req: HttpRequest<any>): Observable<HttpEvent<any>>;

diff --git a/packages/common/http/src/client.ts b/packages/common/http/src/client.ts
@@ -43,7 +43,7 @@ function addBody<T>(
 }
 
 /**
- * @stable
+ *
  */
 export type HttpObserve = 'body' | 'events' | 'response';
 
@@ -54,7 +54,7 @@ export type HttpObserve = 'body' | 'events' | 'response';
  * Each request method has multiple signatures, and the return type varies according to which
  * signature is called (mainly the values of `observe` and `responseType`).
  *
- * @stable
+ *
  */
 @Injectable()
 export class HttpClient {

diff --git a/packages/common/http/src/headers.ts b/packages/common/http/src/headers.ts
@@ -14,7 +14,7 @@ interface Update {
 
 /**
  * Immutable set of Http headers, with lazy parsing.
- * @stable
+ *
  */
 export class HttpHeaders {
   /**

diff --git a/packages/common/http/src/interceptor.ts b/packages/common/http/src/interceptor.ts
@@ -22,7 +22,7 @@ import {HttpEvent} from './response';
  * In rare cases, interceptors may wish to completely handle a request themselves,
  * and not delegate to the remainder of the chain. This behavior is allowed.
  *
- * @stable
+ *
  */
 export interface HttpInterceptor {
   /**
@@ -47,7 +47,7 @@ export interface HttpInterceptor {
 /**
  * `HttpHandler` which applies an `HttpInterceptor` to an `HttpRequest`.
  *
- * @stable
+ *
  */
 export class HttpInterceptorHandler implements HttpHandler {
   constructor(private next: HttpHandler, private interceptor: HttpInterceptor) {}
@@ -61,7 +61,7 @@ export class HttpInterceptorHandler implements HttpHandler {
  * A multi-provider token which represents the array of `HttpInterceptor`s that
  * are registered.
  *
- * @stable
+ *
  */
 export const HTTP_INTERCEPTORS = new InjectionToken<HttpInterceptor[]>('HTTP_INTERCEPTORS');
 

diff --git a/packages/common/http/src/jsonp.ts b/packages/common/http/src/jsonp.ts
@@ -34,15 +34,15 @@ export const JSONP_ERR_WRONG_RESPONSE_TYPE = 'JSONP requests must use Json respo
  *
  * In the browser, this should always be the `window` object.
  *
- * @stable
+ *
  */
 export abstract class JsonpCallbackContext { [key: string]: (data: any) => void; }
 
 /**
  * `HttpBackend` that only processes `HttpRequest` with the JSONP method,
  * by performing JSONP style requests.
  *
- * @stable
+ *
  */
 @Injectable()
 export class JsonpClientBackend implements HttpBackend {
@@ -206,7 +206,7 @@ export class JsonpClientBackend implements HttpBackend {
  * An `HttpInterceptor` which identifies requests with the method JSONP and
  * shifts them to the `JsonpClientBackend`.
  *
- * @stable
+ *
  */
 @Injectable()
 export class JsonpInterceptor {

diff --git a/packages/common/http/src/module.ts b/packages/common/http/src/module.ts
@@ -48,7 +48,7 @@ export class HttpInterceptingHandler implements HttpHandler {
  *
  * Meant to be used as a factory function within `HttpClientModule`.
  *
- * @stable
+ *
  */
 export function interceptingHandler(
     backend: HttpBackend, interceptors: HttpInterceptor[] | null = []): HttpHandler {
@@ -65,7 +65,7 @@ export function interceptingHandler(
  * Ordinarily JSONP callbacks are stored on the `window` object, but this may not exist
  * in test environments. In that case, callbacks are stored on an anonymous object instead.
  *
- * @stable
+ *
  */
 export function jsonpCallbackContext(): Object {
   if (typeof window === 'object') {
@@ -84,7 +84,7 @@ export function jsonpCallbackContext(): Object {
  * If no such names are provided, the default is to use `X-XSRF-TOKEN` for
  * the header name and `XSRF-TOKEN` for the cookie name.
  *
- * @stable
+ *
  */
 @NgModule({
   providers: [
@@ -132,7 +132,7 @@ export class HttpClientXsrfModule {
  * Interceptors can be added to the chain behind `HttpClient` by binding them
  * to the multiprovider for `HTTP_INTERCEPTORS`.
  *
- * @stable
+ *
  */
 @NgModule({
   imports: [
@@ -159,7 +159,7 @@ export class HttpClientModule {
  * Without this module, Jsonp requests will reach the backend
  * with method JSONP, where they'll be rejected.
  *
- * @stable
+ *
  */
 @NgModule({
   providers: [

diff --git a/packages/common/http/src/params.ts b/packages/common/http/src/params.ts
@@ -11,7 +11,7 @@
  *
  * Used by `HttpParams`.
  *
- * @stable
+ *
  **/
 export interface HttpParameterCodec {
   encodeKey(key: string): string;
@@ -25,7 +25,7 @@ export interface HttpParameterCodec {
  * A `HttpParameterCodec` that uses `encodeURIComponent` and `decodeURIComponent` to
  * serialize and parse URL parameter keys and values.
  *
- * @stable
+ *
  */
 export class HttpUrlEncodingCodec implements HttpParameterCodec {
   encodeKey(k: string): string { return standardEncoding(k); }
@@ -94,7 +94,7 @@ export interface HttpParamsOptions {
  *
  * This class is immutable - all mutation operations return a new instance.
  *
- * @stable
+ *
  */
 export class HttpParams {
   private map: Map<string, string[]>|null;

diff --git a/packages/common/http/src/request.ts b/packages/common/http/src/request.ts
@@ -73,7 +73,7 @@ function isFormData(value: any): value is FormData {
  * assumed to be immutable. To modify a `HttpRequest`, the `clone`
  * method should be used.
  *
- * @stable
+ *
  */
 export class HttpRequest<T> {
   /**

diff --git a/packages/common/http/src/response.ts b/packages/common/http/src/response.ts
@@ -11,7 +11,7 @@ import {HttpHeaders} from './headers';
 /**
  * Type enumeration for the different kinds of `HttpEvent`.
  *
- * @stable
+ *
  */
 export enum HttpEventType {
   /**
@@ -48,7 +48,7 @@ export enum HttpEventType {
 /**
  * Base interface for progress events.
  *
- * @stable
+ *
  */
 export interface HttpProgressEvent {
   /**
@@ -71,7 +71,7 @@ export interface HttpProgressEvent {
 /**
  * A download progress event.
  *
- * @stable
+ *
  */
 export interface HttpDownloadProgressEvent extends HttpProgressEvent {
   type: HttpEventType.DownloadProgress;
@@ -87,7 +87,7 @@ export interface HttpDownloadProgressEvent extends HttpProgressEvent {
 /**
  * An upload progress event.
  *
- * @stable
+ *
  */
 export interface HttpUploadProgressEvent extends HttpProgressEvent {
   type: HttpEventType.UploadProgress;
@@ -98,7 +98,7 @@ export interface HttpUploadProgressEvent extends HttpProgressEvent {
  * when a request may be retried multiple times, to distinguish between
  * retries on the final event stream.
  *
- * @stable
+ *
  */
 export interface HttpSentEvent { type: HttpEventType.Sent; }
 
@@ -108,7 +108,7 @@ export interface HttpSentEvent { type: HttpEventType.Sent; }
  * Grouping all custom events under this type ensures they will be handled
  * and forwarded by all implementations of interceptors.
  *
- * @stable
+ *
  */
 export interface HttpUserEvent<T> { type: HttpEventType.User; }
 
@@ -118,7 +118,7 @@ export interface HttpUserEvent<T> { type: HttpEventType.User; }
  *
  * It bundles the Error object with the actual response body that failed to parse.
  *
- * @stable
+ *
  */
 export interface HttpJsonParseError {
   error: Error;
@@ -130,15 +130,15 @@ export interface HttpJsonParseError {
  *
  * Typed according to the expected type of the response.
  *
- * @stable
+ *
  */
 export type HttpEvent<T> =
     HttpSentEvent | HttpHeaderResponse | HttpResponse<T>| HttpProgressEvent | HttpUserEvent<T>;
 
 /**
  * Base class for both `HttpResponse` and `HttpHeaderResponse`.
  *
- * @stable
+ *
  */
 export abstract class HttpResponseBase {
   /**
@@ -206,7 +206,7 @@ export abstract class HttpResponseBase {
  * `HttpHeaderResponse` is a `HttpEvent` available on the response
  * event stream, only when progress events are requested.
  *
- * @stable
+ *
  */
 export class HttpHeaderResponse extends HttpResponseBase {
   /**
@@ -247,7 +247,7 @@ export class HttpHeaderResponse extends HttpResponseBase {
  * `HttpResponse` is a `HttpEvent` available on the response event
  * stream.
  *
- * @stable
+ *
  */
 export class HttpResponse<T> extends HttpResponseBase {
   /**
@@ -297,7 +297,7 @@ export class HttpResponse<T> extends HttpResponseBase {
  * will contain either a wrapped Error object or the error response returned
  * from the server.
  *
- * @stable
+ *
  */
 export class HttpErrorResponse extends HttpResponseBase implements Error {
   readonly name = 'HttpErrorResponse';

diff --git a/packages/common/http/src/xhr.ts b/packages/common/http/src/xhr.ts
@@ -33,14 +33,14 @@ function getResponseUrl(xhr: any): string|null {
 /**
  * A wrapper around the `XMLHttpRequest` constructor.
  *
- * @stable
+ *
  */
 export abstract class XhrFactory { abstract build(): XMLHttpRequest; }
 
 /**
  * A factory for @{link HttpXhrBackend} that uses the `XMLHttpRequest` browser API.
  *
- * @stable
+ *
  */
 @Injectable()
 export class BrowserXhr implements XhrFactory {
@@ -62,7 +62,7 @@ interface PartialResponse {
  * An `HttpBackend` which uses the XMLHttpRequest API to send
  * requests to a backend server.
  *
- * @stable
+ *
  */
 @Injectable()
 export class HttpXhrBackend implements HttpBackend {

diff --git a/packages/common/http/src/xsrf.ts b/packages/common/http/src/xsrf.ts
@@ -21,7 +21,7 @@ export const XSRF_HEADER_NAME = new InjectionToken<string>('XSRF_HEADER_NAME');
 /**
  * Retrieves the current XSRF token to use with the next outgoing request.
  *
- * @stable
+ *
  */
 export abstract class HttpXsrfTokenExtractor {
   /**

diff --git a/packages/common/http/testing/src/api.ts b/packages/common/http/testing/src/api.ts
@@ -13,7 +13,7 @@ import {TestRequest} from './request';
 /**
  * Defines a matcher for requests based on URL, method, or both.
  *
- * @stable
+ *
  */
 export interface RequestMatch {
   method?: string;
@@ -24,7 +24,7 @@ export interface RequestMatch {
  * Controller to be injected into tests, that allows for mocking and flushing
  * of requests.
  *
- * @stable
+ *
  */
 export abstract class HttpTestingController {
   /**

diff --git a/packages/common/http/testing/src/backend.ts b/packages/common/http/testing/src/backend.ts
@@ -23,7 +23,7 @@ import {TestRequest} from './request';
  * requests were made and then flush them. In the end, a verify() method asserts
  * that no unexpected requests were made.
  *
- * @stable
+ *
  */
 @Injectable()
 export class HttpClientTestingBackend implements HttpBackend, HttpTestingController {

diff --git a/packages/common/http/testing/src/module.ts b/packages/common/http/testing/src/module.ts
@@ -18,7 +18,7 @@ import {HttpClientTestingBackend} from './backend';
  *
  * Inject `HttpTestingController` to expect and flush requests in your tests.
  *
- * @stable
+ *
  */
 @NgModule({
   imports: [

diff --git a/packages/common/http/testing/src/request.ts b/packages/common/http/testing/src/request.ts
@@ -15,7 +15,7 @@ import {Observer} from 'rxjs';
  * This interface allows access to the underlying `HttpRequest`, and allows
  * responding with `HttpEvent`s or `HttpErrorResponse`s.
  *
- * @stable
+ *
  */
 export class TestRequest {
   /**

diff --git a/packages/common/src/common_module.ts b/packages/common/src/common_module.ts
@@ -18,7 +18,7 @@ import {COMMON_PIPES} from './pipes/index';
 /**
  * The module that includes all the basic Angular directives like {@link NgIf}, {@link NgForOf}, ...
  *
- * @stable
+ *
  */
 @NgModule({
   declarations: [COMMON_DIRECTIVES, COMMON_PIPES],