cargdev/angular
1
0
Fork 0
Code Issues 12 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: remove all deprecated @stable jsdoc tags (#23210)

Browse Source 
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:
Pete Bacon Darwin
2018-04-05 22:31:44 +01:00
committed by Igor Minar
parent ee145790d7
commit 4b96a58c5a
155 changed files with 363 additions and 643 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
packages/core/src/metadata/di.ts
View File

@ -49,7 +49,7 @@ export const ANALYZE_FOR_ENTRY_COMPONENTS = new InjectionToken<any>('AnalyzeForE
/**
* Type of the Attribute decorator / constructor function.
*
* @stable
*
*/
export interface AttributeDecorator {
/**
@ -88,7 +88,7 @@ export interface AttributeDecorator {
* ]
* ```
*
* @stable
*
*/
(name: string): any;
new (name: string): Attribute;
@ -103,7 +103,7 @@ export interface Attribute { attributeName?: string; }
/**
* Attribute decorator and metadata.
*
* @stable
*
* @Annotation
*/
export const Attribute: AttributeDecorator =
@ -112,7 +112,7 @@ export const Attribute: AttributeDecorator =
/**
* Type of the Query metadata.
*
* @stable
*
*/
export interface Query {
descendants: boolean;
@ -128,7 +128,7 @@ export interface Query {
* See {@link ContentChildren}, {@link ContentChild}, {@link ViewChildren}, {@link ViewChild} for
* more information.
*
* @stable
*
*/
export abstract class Query {}
@ -137,7 +137,7 @@ export abstract class Query {}
*
* See {@link ContentChildren}.
*
* @stable
*
*/
export interface ContentChildrenDecorator {
/**
@ -168,7 +168,7 @@ export interface ContentChildrenDecorator {
*
* **npm package**: `@angular/core`
*
* @stable
*
* @Annotation
*/
(selector: Type<any>|Function|string, opts?: {descendants?: boolean, read?: any}): any;
@ -178,7 +178,7 @@ export interface ContentChildrenDecorator {
/**
* Type of the ContentChildren metadata.
*
* @stable
*
* @Annotation
*/
export type ContentChildren = Query;
@ -186,7 +186,7 @@ export type ContentChildren = Query;
/**
* ContentChildren decorator and metadata.
*
* @stable
*
* @Annotation
*/
export const ContentChildren: ContentChildrenDecorator = makePropDecorator(
@ -199,7 +199,7 @@ export const ContentChildren: ContentChildrenDecorator = makePropDecorator(
* Type of the ContentChild decorator / constructor function.
*
*
* @stable
*
*/
export interface ContentChildDecorator {
/**
@ -228,7 +228,7 @@ export interface ContentChildDecorator {
*
* **npm package**: `@angular/core`
*
* @stable
*
* @Annotation
*/
(selector: Type<any>|Function|string, opts?: {read?: any}): any;
@ -240,14 +240,14 @@ export interface ContentChildDecorator {
*
* See {@link ContentChild}.
*
* @stable
*
*/
export type ContentChild = Query;
/**
* ContentChild decorator and metadata.
*
* @stable
*
* @Annotation
*/
export const ContentChild: ContentChildDecorator = makePropDecorator(
@ -260,7 +260,7 @@ export const ContentChild: ContentChildDecorator = makePropDecorator(
*
* See {@link ViewChildren}.
*
* @stable
*
*/
export interface ViewChildrenDecorator {
/**
@ -289,7 +289,7 @@ export interface ViewChildrenDecorator {
*
* **npm package**: `@angular/core`
*
* @stable
*
* @Annotation
*/
(selector: Type<any>|Function|string, opts?: {read?: any}): any;
@ -299,14 +299,14 @@ export interface ViewChildrenDecorator {
/**
* Type of the ViewChildren metadata.
*
* @stable
*
*/
export type ViewChildren = Query;
/**
* ViewChildren decorator and metadata.
*
* @stable
*
* @Annotation
*/
export const ViewChildren: ViewChildrenDecorator = makePropDecorator(
@ -319,7 +319,7 @@ export const ViewChildren: ViewChildrenDecorator = makePropDecorator(
*
* See {@link ViewChild}
*
* @stable
*
*/
export interface ViewChildDecorator {
/**
@ -346,7 +346,7 @@ export interface ViewChildDecorator {
*
* **npm package**: `@angular/core`
*
* @stable
*
* @Annotation
*/
(selector: Type<any>|Function|string, opts?: {read?: any}): any;
@ -356,14 +356,14 @@ export interface ViewChildDecorator {
/**
* Type of the ViewChild metadata.
*
* @stable
*
*/
export type ViewChild = Query;
/**
* ViewChild decorator and metadata.
*
* @stable
*
* @Annotation
*/
export const ViewChild: ViewChildDecorator = makePropDecorator(

52
packages/core/src/metadata/directives.ts
View File

@ -17,7 +17,7 @@ import {ViewEncapsulation} from './view';
/**
* Type of the Directive decorator / constructor function.
*
* @stable
*
*/
export interface DirectiveDecorator {
/**
@ -65,7 +65,7 @@ export interface DirectiveDecorator {
* * **queries** - configure queries that can be injected into the component
* * **selector** - css selector that identifies this component in a template
*
* @stable
*
* @Annotation
*/
(obj: Directive): TypeDecorator;
@ -397,7 +397,7 @@ export interface Directive {
/**
* Directive decorator and metadata.
*
* @stable
*
* @Annotation
*/
export const Directive: DirectiveDecorator =
@ -406,7 +406,7 @@ export const Directive: DirectiveDecorator =
/**
* Type of the Component decorator / constructor function.
*
* @stable
*
*/
export interface ComponentDecorator {
/**
@ -462,7 +462,7 @@ export interface ComponentDecorator {
*
* {@example core/ts/metadata/metadata.ts region='component'}
*
* @stable
*
* @Annotation
*/
(obj: Component): TypeDecorator;
@ -475,7 +475,7 @@ export interface ComponentDecorator {
/**
* Type of the Component metadata.
*
* @stable
*
*/
export interface Component extends Directive {
/**
@ -749,7 +749,7 @@ export interface Component extends Directive {
/**
* Component decorator and metadata.
*
* @stable
*
* @Annotation
*/
export const Component: ComponentDecorator = makeDecorator(
@ -759,7 +759,7 @@ export const Component: ComponentDecorator = makeDecorator(
/**
* Type of the Pipe decorator / constructor function.
*
* @stable
*
*/
export interface PipeDecorator {
/**
@ -780,7 +780,7 @@ export interface PipeDecorator {
/**
* Type of the Pipe metadata.
*
* @stable
*
*/
export interface Pipe {
/**
@ -813,7 +813,7 @@ export interface Pipe {
* To use the pipe include a reference to the pipe class in
* {@link NgModule#declarations}.
*
* @stable
*
* @Annotation
*/
export const Pipe: PipeDecorator = makeDecorator('Pipe', (p: Pipe) => ({pure: true, ...p}));
@ -822,7 +822,7 @@ export const Pipe: PipeDecorator = makeDecorator('Pipe', (p: Pipe) => ({pure: tr
/**
* Type of the Input decorator / constructor function.
*
* @stable
*
*/
export interface InputDecorator {
/**
@ -863,7 +863,7 @@ export interface InputDecorator {
*
* class App {}
* ```
* @stable
*
*/
(bindingPropertyName?: string): any;
new (bindingPropertyName?: string): any;
@ -872,7 +872,7 @@ export interface InputDecorator {
/**
* Type of the Input metadata.
*
* @stable
*
*/
export interface Input {
/**
@ -884,7 +884,7 @@ export interface Input {
/**
* Input decorator and metadata.
*
* @stable
*
* @Annotation
*/
export const Input: InputDecorator =
@ -893,7 +893,7 @@ export const Input: InputDecorator =
/**
* Type of the Output decorator / constructor function.
*
* @stable
*
*/
export interface OutputDecorator {
/**
@ -934,7 +934,7 @@ export interface OutputDecorator {
* everyFiveSeconds() { console.log('five seconds'); }
* }
* ```
* @stable
*
*/
(bindingPropertyName?: string): any;
new (bindingPropertyName?: string): any;
@ -943,14 +943,14 @@ export interface OutputDecorator {
/**
* Type of the Output metadata.
*
* @stable
*
*/
export interface Output { bindingPropertyName?: string; }
/**
* Output decorator and metadata.
*
* @stable
*
* @Annotation
*/
export const Output: OutputDecorator =
@ -960,7 +960,7 @@ export const Output: OutputDecorator =
/**
* Type of the HostBinding decorator / constructor function.
*
* @stable
*
*/
export interface HostBindingDecorator {
/**
@ -994,7 +994,7 @@ export interface HostBindingDecorator {
* prop;
* }
* ```
* @stable
*
*/
(hostPropertyName?: string): any;
new (hostPropertyName?: string): any;
@ -1003,14 +1003,14 @@ export interface HostBindingDecorator {
/**
* Type of the HostBinding metadata.
*
* @stable
*
*/
export interface HostBinding { hostPropertyName?: string; }
/**
* HostBinding decorator and metadata.
*
* @stable
*
* @Annotation
*/
export const HostBinding: HostBindingDecorator =
@ -1020,7 +1020,7 @@ export const HostBinding: HostBindingDecorator =
/**
* Type of the HostListener decorator / constructor function.
*
* @stable
*
*/
export interface HostListenerDecorator {
/**
@ -1052,7 +1052,7 @@ export interface HostListenerDecorator {
* })
* class App {}
* ```
* @stable
*
* @Annotation
*/
(eventName: string, args?: string[]): any;
@ -1062,7 +1062,7 @@ export interface HostListenerDecorator {
/**
* Type of the HostListener metadata.
*
* @stable
*
*/
export interface HostListener {
eventName?: string;
@ -1072,7 +1072,7 @@ export interface HostListener {
/**
* HostListener decorator and metadata.
*
* @stable
*
* @Annotation
*/
export const HostListener: HostListenerDecorator =

18
packages/core/src/metadata/lifecycle_hooks.ts
View File

@ -12,7 +12,7 @@ import {SimpleChange} from '../change_detection/change_detection_util';
/**
* A `changes` object whose keys are property names and
* values are instances of {@link SimpleChange}. See {@link OnChanges}
* @stable
*
*/
export interface SimpleChanges { [propName: string]: SimpleChange; }
@ -29,7 +29,7 @@ export interface SimpleChanges { [propName: string]: SimpleChange; }
*
* See {@linkDocs guide/lifecycle-hooks#onchanges "Lifecycle Hooks Guide"}.
*
* @stable
*
*/
export interface OnChanges { ngOnChanges(changes: SimpleChanges): void; }
@ -47,7 +47,7 @@ export interface OnChanges { ngOnChanges(changes: SimpleChanges): void; }
*
* See {@linkDocs guide/lifecycle-hooks "Lifecycle Hooks Guide"}.
*
* @stable
*
*/
export interface OnInit { ngOnInit(): void; }
@ -71,7 +71,7 @@ export interface OnInit { ngOnInit(): void; }
*
* See {@linkDocs guide/lifecycle-hooks#docheck "Lifecycle Hooks Guide"}.
*
* @stable
*
*/
export interface DoCheck { ngDoCheck(): void; }
@ -87,7 +87,7 @@ export interface DoCheck { ngDoCheck(): void; }
*
* See {@linkDocs guide/lifecycle-hooks "Lifecycle Hooks Guide"}.
*
* @stable
*
*/
export interface OnDestroy { ngOnDestroy(): void; }
@ -102,7 +102,7 @@ export interface OnDestroy { ngOnDestroy(): void; }
*
* See {@linkDocs guide/lifecycle-hooks#aftercontent "Lifecycle Hooks Guide"}.
*
* @stable
*
*/
export interface AfterContentInit { ngAfterContentInit(): void; }
@ -115,7 +115,7 @@ export interface AfterContentInit { ngAfterContentInit(): void; }
*
* See {@linkDocs guide/lifecycle-hooks#aftercontent "Lifecycle Hooks Guide"}.
*
* @stable
*
*/
export interface AfterContentChecked { ngAfterContentChecked(): void; }
@ -129,7 +129,7 @@ export interface AfterContentChecked { ngAfterContentChecked(): void; }
*
* See {@linkDocs guide/lifecycle-hooks#afterview "Lifecycle Hooks Guide"}.
*
* @stable
*
*/
export interface AfterViewInit { ngAfterViewInit(): void; }
@ -142,6 +142,6 @@ export interface AfterViewInit { ngAfterViewInit(): void; }
*
* See {@linkDocs guide/lifecycle-hooks#afterview "Lifecycle Hooks Guide"}.
*
* @stable
*
*/
export interface AfterViewChecked { ngAfterViewChecked(): void; }

10
packages/core/src/metadata/ng_module.ts
View File

@ -16,7 +16,7 @@ import {TypeDecorator, makeDecorator} from '../util/decorators';
/**
* A wrapper around a module that also includes the providers.
*
* @stable
*
*/
export interface ModuleWithProviders {
ngModule: Type<any>;
@ -36,7 +36,7 @@ export interface SchemaMetadata { name: string; }
* - any properties on elements with a `-` in their name which is the common rule for custom
* elements.
*
* @stable
*
*/
export const CUSTOM_ELEMENTS_SCHEMA: SchemaMetadata = {
name: 'custom-elements'
@ -55,7 +55,7 @@ export const NO_ERRORS_SCHEMA: SchemaMetadata = {
/**
* Type of the NgModule decorator / constructor function.
*
* @stable
*
*/
export interface NgModuleDecorator {
/**
@ -68,7 +68,7 @@ export interface NgModuleDecorator {
/**
* Type of the NgModule metadata.
*
* @stable
*
*/
export interface NgModule {
/**
@ -190,7 +190,7 @@ export interface NgModule {
/**
* NgModule decorator and metadata.
*
* @stable
*
* @Annotation
*/
export const NgModule: NgModuleDecorator = makeDecorator(

2
packages/core/src/metadata/view.ts
View File

@ -10,7 +10,7 @@
* Defines template and style encapsulation options available for Component's {@link Component}.
*
* See {@link Component#encapsulation encapsulation}.
* @stable
*
*/
export enum ViewEncapsulation {
/**