cargdev/angular
1
0
Fork 0
Code Issues 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

10
packages/core/src/application_ref.ts
View File

@ -41,7 +41,7 @@ export const ALLOW_MULTIPLE_PLATFORMS = new InjectionToken<boolean>('AllowMultip
* does not result in additional changes to any bindings (also known as
* unidirectional data flow).
*
* @stable
*
*/
export function enableProdMode(): void {
if (_runModeLocked) {
@ -160,7 +160,7 @@ export function getPlatform(): PlatformRef|null {
/**
* Provides additional options to the bootstraping process.
*
* @stable
*
*/
export interface BootstrapOptions {
/**
@ -181,7 +181,7 @@ export interface BootstrapOptions {
* A page's platform is initialized implicitly when a platform is created via a platform factory
* (e.g. {@link platformBrowser}), or explicitly by calling the {@link createPlatform} function.
*
* @stable
*
*/
@Injectable()
export class PlatformRef {
@ -262,7 +262,7 @@ export class PlatformRef {
*
* let moduleRef = platformBrowser().bootstrapModule(MyModule);
* ```
* @stable
*
*/
bootstrapModule<M>(
moduleType: Type<M>, compilerOptions: (CompilerOptions&BootstrapOptions)|
@ -359,7 +359,7 @@ function optionsReducer<T extends Object>(dst: any, objs: T | T[]): T {
/**
* A reference to an Angular application running on a page.
*
* @stable
*
*/
@Injectable()
export class ApplicationRef {

4
packages/core/src/change_detection/change_detection_util.ts
View File

@ -41,7 +41,7 @@ export function devModeEqual(a: any, b: any): boolean {
* return WrappedValue.wrap(this._latestValue); // this will force update
* }
* ```
* @stable
*
*/
export class WrappedValue {
/** @deprecated from 5.3, use `unwrap()` instead - will switch to protected */
@ -64,7 +64,7 @@ export class WrappedValue {
/**
* Represents a basic change from a previous to a new value.
* @stable
*
*/
export class SimpleChange {
constructor(public previousValue: any, public currentValue: any, public firstChange: boolean) {}

2
packages/core/src/change_detection/change_detector_ref.ts
View File

@ -7,7 +7,7 @@
*/
/**
* @stable
*
*/
export abstract class ChangeDetectorRef {
/**

2
packages/core/src/change_detection/constants.ts
View File

@ -10,7 +10,7 @@
/**
* Describes within the change detector which strategy will be used the next time change
* detection is triggered.
* @stable
*
*/
export enum ChangeDetectionStrategy {
/**

2
packages/core/src/change_detection/differs/default_iterable_differ.ts
View File

@ -558,7 +558,7 @@ export class DefaultIterableDiffer<V> implements IterableDiffer<V>, IterableChan
}
/**
* @stable
*
*/
export class IterableChangeRecord_<V> implements IterableChangeRecord<V> {
currentIndex: number|null = null;

2
packages/core/src/change_detection/differs/default_keyvalue_differ.ts
View File

@ -261,7 +261,7 @@ export class DefaultKeyValueDiffer<K, V> implements KeyValueDiffer<K, V>, KeyVal
/**
* @stable
*
*/
class KeyValueChangeRecord_<K, V> implements KeyValueChangeRecord<K, V> {
previousValue: V|null = null;

14
packages/core/src/change_detection/differs/iterable_differs.ts
View File

@ -13,7 +13,7 @@ import {StaticProvider} from '../../di/provider';
/**
* A type describing supported iterable types.
*
* @stable
*
*/
export type NgIterable<T> = Array<T>| Iterable<T>;
@ -21,7 +21,7 @@ export type NgIterable<T> = Array<T>| Iterable<T>;
* A strategy for tracking changes over time to an iterable. Used by {@link NgForOf} to
* respond to changes in an iterable by effecting equivalent changes in the DOM.
*
* @stable
*
*/
export interface IterableDiffer<V> {
/**
@ -38,7 +38,7 @@ export interface IterableDiffer<V> {
* An object describing the changes in the `Iterable` collection since last time
* `IterableDiffer#diff()` was invoked.
*
* @stable
*
*/
export interface IterableChanges<V> {
/**
@ -91,7 +91,7 @@ export interface IterableChanges<V> {
/**
* Record representing the item change information.
*
* @stable
*
*/
export interface IterableChangeRecord<V> {
/** Current index of the item in `Iterable` or null if removed. */
@ -116,14 +116,14 @@ export interface CollectionChangeRecord<V> extends IterableChangeRecord<V> {}
* An optional function passed into {@link NgForOf} that defines how to track
* items in an iterable (e.g. fby index or id)
*
* @stable
*
*/
export interface TrackByFunction<T> { (index: number, item: T): any; }
/**
* Provides a factory for {@link IterableDiffer}.
*
* @stable
*
*/
export interface IterableDifferFactory {
supports(objects: any): boolean;
@ -132,7 +132,7 @@ export interface IterableDifferFactory {
/**
* A repository of different iterable diffing strategies used by NgFor, NgClass, and others.
* @stable
*
*/
export class IterableDiffers {
/**

10
packages/core/src/change_detection/differs/keyvalue_differs.ts
View File

@ -12,7 +12,7 @@ import {Optional, SkipSelf, StaticProvider} from '../../di';
/**
* A differ that tracks changes made to an object over time.
*
* @stable
*
*/
export interface KeyValueDiffer<K, V> {
/**
@ -40,7 +40,7 @@ export interface KeyValueDiffer<K, V> {
* An object describing the changes in the `Map` or `{[k:string]: string}` since last time
* `KeyValueDiffer#diff()` was invoked.
*
* @stable
*
*/
export interface KeyValueChanges<K, V> {
/**
@ -74,7 +74,7 @@ export interface KeyValueChanges<K, V> {
/**
* Record representing the item change information.
*
* @stable
*
*/
export interface KeyValueChangeRecord<K, V> {
/**
@ -96,7 +96,7 @@ export interface KeyValueChangeRecord<K, V> {
/**
* Provides a factory for {@link KeyValueDiffer}.
*
* @stable
*
*/
export interface KeyValueDifferFactory {
/**
@ -112,7 +112,7 @@ export interface KeyValueDifferFactory {
/**
* A repository of different Map diffing strategies used by NgClass, NgStyle, and others.
* @stable
*
*/
export class KeyValueDiffers {
/**

2
packages/core/src/change_detection/pipe_transform.ts
View File

@ -33,6 +33,6 @@
*
* Invoking `{{ 'ok' | repeat:3 }}` in a template produces `okokok`.
*
* @stable
*
*/
export interface PipeTransform { transform(value: any, ...args: any[]): any; }

6
packages/core/src/di/injectable.ts
View File

@ -30,7 +30,7 @@ export type InjectableProvider = ValueSansProvider | ExistingSansProvider |
/**
* Type of the Injectable decorator / constructor function.
*
* @stable
*
*/
export interface InjectableDecorator {
/**
@ -54,7 +54,7 @@ export interface InjectableDecorator {
*
* {@example core/di/ts/metadata_spec.ts region='InjectableThrows'}
*
* @stable
*
*/
(): any;
(options?: {providedIn: Type<any>| 'root' | null}&InjectableProvider): any;
@ -113,7 +113,7 @@ export function convertInjectableProviderToFactory(
/**
* Injectable decorator and metadata.
*
* @stable
*
* @Annotation
*/
export const Injectable: InjectableDecorator = makeDecorator(

2
packages/core/src/di/injection_token.ts
View File

@ -46,7 +46,7 @@ import {InjectableDef, defineInjectable} from './defs';
*
* {@example core/di/ts/injector_spec.ts region='InjectionToken'}
*
* @stable
*
*/
export class InjectionToken<T> {
/** @internal */

4
packages/core/src/di/injector.ts
View File

@ -58,7 +58,7 @@ export class NullInjector implements Injector {
* `Injector` returns itself when given `Injector` as a token:
* {@example core/di/ts/injector_spec.ts region='injectInjector'}
*
* @stable
*
*/
export abstract class Injector {
static THROW_IF_NOT_FOUND = _THROW_IF_NOT_FOUND;
@ -412,7 +412,7 @@ function getClosureSafeProperty<T>(objWithPropertyToExtract: T): string {
/**
* Injection flags for DI.
*
* @stable
*
*/
export const enum InjectFlags {
Default = 0,

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

@ -16,7 +16,7 @@ import {EMPTY_ARRAY} from '../view/util';
/**
* Type of the Inject decorator / constructor function.
*
* @stable
*
*/
export interface InjectDecorator {
/**
@ -44,7 +44,7 @@ export interface InjectDecorator {
*
* {@example core/di/ts/metadata_spec.ts region='InjectWithoutDecorator'}
*
* @stable
*
*/
(token: any): any;
new (token: any): Inject;
@ -53,14 +53,14 @@ export interface InjectDecorator {
/**
* Type of the Inject metadata.
*
* @stable
*
*/
export interface Inject { token: any; }
/**
* Inject decorator and metadata.
*
* @stable
*
* @Annotation
*/
export const Inject: InjectDecorator = makeParamDecorator('Inject', (token: any) => ({token}));
@ -69,7 +69,7 @@ export const Inject: InjectDecorator = makeParamDecorator('Inject', (token: any)
/**
* Type of the Optional decorator / constructor function.
*
* @stable
*
*/
export interface OptionalDecorator {
/**
@ -91,7 +91,7 @@ export interface OptionalDecorator {
*
* {@example core/di/ts/metadata_spec.ts region='Optional'}
*
* @stable
*
*/
(): any;
new (): Optional;
@ -100,14 +100,14 @@ export interface OptionalDecorator {
/**
* Type of the Optional metadata.
*
* @stable
*
*/
export interface Optional {}
/**
* Optional decorator and metadata.
*
* @stable
*
* @Annotation
*/
export const Optional: OptionalDecorator = makeParamDecorator('Optional');
@ -115,7 +115,7 @@ export const Optional: OptionalDecorator = makeParamDecorator('Optional');
/**
* Type of the Self decorator / constructor function.
*
* @stable
*
*/
export interface SelfDecorator {
/**
@ -136,7 +136,7 @@ export interface SelfDecorator {
*
* {@example core/di/ts/metadata_spec.ts region='Self'}
*
* @stable
*
*/
(): any;
new (): Self;
@ -145,14 +145,14 @@ export interface SelfDecorator {
/**
* Type of the Self metadata.
*
* @stable
*
*/
export interface Self {}
/**
* Self decorator and metadata.
*
* @stable
*
* @Annotation
*/
export const Self: SelfDecorator = makeParamDecorator('Self');
@ -161,7 +161,7 @@ export const Self: SelfDecorator = makeParamDecorator('Self');
/**
* Type of the SkipSelf decorator / constructor function.
*
* @stable
*
*/
export interface SkipSelfDecorator {
/**
@ -182,7 +182,7 @@ export interface SkipSelfDecorator {
*
* {@example core/di/ts/metadata_spec.ts region='SkipSelf'}
*
* @stable
*
*/
(): any;
new (): SkipSelf;
@ -191,14 +191,14 @@ export interface SkipSelfDecorator {
/**
* Type of the SkipSelf metadata.
*
* @stable
*
*/
export interface SkipSelf {}
/**
* SkipSelf decorator and metadata.
*
* @stable
*
* @Annotation
*/
export const SkipSelf: SkipSelfDecorator = makeParamDecorator('SkipSelf');
@ -206,7 +206,7 @@ export const SkipSelf: SkipSelfDecorator = makeParamDecorator('SkipSelf');
/**
* Type of the Host decorator / constructor function.
*
* @stable
*
*/
export interface HostDecorator {
/**
@ -228,7 +228,7 @@ export interface HostDecorator {
*
* {@example core/di/ts/metadata_spec.ts region='Host'}
*
* @stable
*
*/
(): any;
new (): Host;
@ -237,14 +237,14 @@ export interface HostDecorator {
/**
* Type of the Host metadata.
*
* @stable
*
*/
export interface Host {}
/**
* Host decorator and metadata.
*
* @stable
*
* @Annotation
*/
export const Host: HostDecorator = makeParamDecorator('Host');

20
packages/core/src/di/provider.ts
View File

@ -48,7 +48,7 @@ export interface ValueSansProvider {
*
* {@example core/di/ts/provider_spec.ts region='ValueProvider'}
*
* @stable
*
*/
export interface ValueProvider extends ValueSansProvider {
/**
@ -120,7 +120,7 @@ export interface StaticClassSansProvider {
* Note that following two providers are not equal:
* {@example core/di/ts/provider_spec.ts region='StaticClassProviderDifference'}
*
* @stable
*
*/
export interface StaticClassProvider extends StaticClassSansProvider {
/**
@ -183,7 +183,7 @@ export interface ConstructorSansProvider {
*
* {@example core/di/ts/provider_spec.ts region='ConstructorProvider'}
*
* @stable
*
*/
export interface ConstructorProvider extends ConstructorSansProvider {
/**
@ -218,7 +218,7 @@ export interface ConstructorProvider extends ConstructorSansProvider {
*
* {@example core/di/ts/provider_spec.ts region='ExistingSansProvider'}
*
* @stable
*
*/
export interface ExistingSansProvider {
/**
@ -242,7 +242,7 @@ export interface ExistingSansProvider {
*
* {@example core/di/ts/provider_spec.ts region='ExistingProvider'}
*
* @stable
*
*/
export interface ExistingProvider extends ExistingSansProvider {
/**
@ -315,7 +315,7 @@ export interface FactorySansProvider {
* Dependencies can also be marked as optional:
* {@example core/di/ts/provider_spec.ts region='FactoryProviderOptionalDeps'}
*
* @stable
*
*/
export interface FactoryProvider extends FactorySansProvider {
/**
@ -343,7 +343,7 @@ export interface FactoryProvider extends FactorySansProvider {
*
* For more details, see the {@linkDocs guide/dependency-injection "Dependency Injection Guide"}.
*
* @stable
*
*/
export type StaticProvider = ValueProvider | ExistingProvider | StaticClassProvider |
ConstructorProvider | FactoryProvider | any[];
@ -370,7 +370,7 @@ export type StaticProvider = ValueProvider | ExistingProvider | StaticClassProvi
*
* {@example core/di/ts/provider_spec.ts region='TypeProvider'}
*
* @stable
*
*/
export interface TypeProvider extends Type<any> {}
@ -423,7 +423,7 @@ export interface ClassSansProvider {
* Note that following two providers are not equal:
* {@example core/di/ts/provider_spec.ts region='ClassProviderDifference'}
*
* @stable
*
*/
export interface ClassProvider extends ClassSansProvider {
/**
@ -451,7 +451,7 @@ export interface ClassProvider extends ClassSansProvider {
*
* For more details, see the {@linkDocs guide/dependency-injection "Dependency Injection Guide"}.
*
* @stable
*
*/
export type Provider =
TypeProvider | ValueProvider | ClassProvider | ExistingProvider | FactoryProvider | any[];

4
packages/core/src/di/reflective_errors.ts
View File

@ -187,7 +187,7 @@ export function invalidProviderError(provider: any) {
*
* expect(() => Injector.resolveAndCreate([A,B])).toThrowError();
* ```
* @stable
*
*/
export function noAnnotationError(typeOrFunc: Type<any>| Function, params: any[][]): Error {
const signature: string[] = [];
@ -218,7 +218,7 @@ export function noAnnotationError(typeOrFunc: Type<any>| Function, params: any[]
*
* expect(() => injector.getAt(100)).toThrowError();
* ```
* @stable
*
*/
export function outOfBoundsError(index: number) {
return Error(`Index ${index} is out-of-bounds.`);

2
packages/core/src/error_handler.ts
View File

@ -34,7 +34,7 @@ import {ERROR_ORIGINAL_ERROR, getDebugContext, getErrorLogger, getOriginalError}
* class MyModule {}
* ```
*
* @stable
*
*/
export class ErrorHandler {
/**

2
packages/core/src/event_emitter.ts
View File

@ -53,7 +53,7 @@ import {Subject, Subscription} from 'rxjs';
* https://github.com/jhusain/observable-spec
*
* Once a reference implementation of the spec is available, switch to it.
* @stable
*
*/
export class EventEmitter<T> extends Subject<T> {
// TODO: mark this as internal once all the facades are gone

2
packages/core/src/linker/compiler.ts
View File

@ -39,7 +39,7 @@ function _throwError() {
* Each `@NgModule` provides an own `Compiler` to its injector,
* that will use the directives/pipes of the ng module for compilation
* of components.
* @stable
*
*/
@Injectable()
export class Compiler {

4
packages/core/src/linker/component_factory.ts
View File

@ -20,7 +20,7 @@ import {ViewRef} from './view_ref';
* `ComponentRef` provides access to the Component Instance as well other objects related to this
* Component Instance and allows you to destroy the Component Instance via the {@link #destroy}
* method.
* @stable
*
*/
export abstract class ComponentRef<C> {
/**
@ -65,7 +65,7 @@ export abstract class ComponentRef<C> {
}
/**
* @stable
*
*/
export abstract class ComponentFactory<C> {
abstract get selector(): string;

2
packages/core/src/linker/component_factory_resolver.ts
View File

@ -34,7 +34,7 @@ class _NullComponentFactoryResolver implements ComponentFactoryResolver {
}
/**
* @stable
*
*/
export abstract class ComponentFactoryResolver {
static NULL: ComponentFactoryResolver = new _NullComponentFactoryResolver();

4
packages/core/src/linker/element_ref.ts
View File

@ -16,7 +16,7 @@
* XSS attacks. Carefully review any use of `ElementRef` in your code. For more detail, see the
* [Security Guide](http://g.co/ng/security).
*
* @stable
*
*/
// Note: We don't expose things like `Injector`, `ViewContainer`, ... here,
// i.e. users have to ask for what they need. With that, we can build better analysis tools
@ -41,7 +41,7 @@ export class ElementRef<T = any> {
* web worker.
* </p>
* </div>
* @stable
*
*/
public nativeElement: T;

2
packages/core/src/linker/ng_module_factory.ts
View File

@ -18,7 +18,7 @@ import {ComponentFactoryResolver} from './component_factory_resolver';
* `NgModuleRef` provides access to the NgModule Instance as well other objects related to this
* NgModule Instance.
*
* @stable
*
*/
export abstract class NgModuleRef<T> {
/**

2
packages/core/src/linker/ng_module_factory_loader.ts
View File

@ -10,7 +10,7 @@ import {NgModuleFactory} from './ng_module_factory';
/**
* Used to load ng module factories.
* @stable
*
*/
export abstract class NgModuleFactoryLoader {
abstract load(path: string): Promise<NgModuleFactory<any>>;

2
packages/core/src/linker/query_list.ts
View File

@ -34,7 +34,7 @@ import {getSymbolIterator} from '../util';
* @ViewChildren(Item) items:QueryList<Item>;
* }
* ```
* @stable
*
*/
export class QueryList<T>/* implements Iterable<T> */ {
public readonly dirty = true;

2
packages/core/src/linker/template_ref.ts
View File

@ -20,7 +20,7 @@ import {EmbeddedViewRef} from './view_ref';
*
* To instantiate Embedded Views based on a Template, use {@link ViewContainerRef#
* createEmbeddedView}, which will create the View and attach it to the View Container.
* @stable
*
*/
export abstract class TemplateRef<C> {
/**

2
packages/core/src/linker/view_container_ref.ts
View File

@ -30,7 +30,7 @@ import {EmbeddedViewRef, ViewRef} from './view_ref';
*
* To access a `ViewContainerRef` of an Element, you can either place a {@link Directive} injected
* with `ViewContainerRef` on the Element, or you obtain it via a {@link ViewChild} query.
* @stable
*
*/
export abstract class ViewContainerRef {
/**

2
packages/core/src/linker/view_ref.ts
View File

@ -11,7 +11,7 @@ import {ChangeDetectorRef} from '../change_detection/change_detector_ref';
/**
* @stable
*
*/
export abstract class ViewRef extends ChangeDetectorRef {
/**

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 {
/**

4
packages/core/src/sanitization/security.ts
View File

@ -13,7 +13,7 @@
*
* See DomSanitizer for more details on security in Angular applications.
*
* @stable
*
*/
export enum SecurityContext {
NONE = 0,
@ -27,7 +27,7 @@ export enum SecurityContext {
/**
* Sanitizer is used by the views to sanitize potentially dangerous values.
*
* @stable
*
*/
export abstract class Sanitizer {
abstract sanitize(context: SecurityContext, value: {}|string|null): string|null;

2
packages/core/src/type.ts
View File

@ -14,7 +14,7 @@
* An example of a `Type` is `MyCustomComponent` class, which in JavaScript is be represented by
* the `MyCustomComponent` constructor function.
*
* @stable
*
*/
export const Type = Function;

2
packages/core/src/util/decorators.ts
View File

@ -19,7 +19,7 @@ import {Type} from '../type';
* @ng.Component({...})
* class MyClass {...}
* ```
* @stable
*
*/
export interface TypeDecorator {
/**

4
packages/core/src/version.ts
View File

@ -9,7 +9,7 @@
/**
* @description Represents the version of Angular
*
* @stable
*
*/
export class Version {
public readonly major: string;
@ -24,6 +24,6 @@ export class Version {
}
/**
* @stable
*
*/
export const VERSION = new Version('0.0.0-PLACEHOLDER');

2
packages/core/testing/src/async.ts
View File

@ -23,7 +23,7 @@ import {asyncFallback} from './async_fallback';
* });
* ```
*
* @stable
*
*/
export function async(fn: Function): (done: any) => any {
const _Zone: any = typeof Zone !== 'undefined' ? Zone : null;

2
packages/core/testing/src/async_fallback.ts
View File

@ -29,7 +29,7 @@ const _global = <any>(typeof window === 'undefined' ? global : window);
* });
* ```
*
* @stable
*
*/
export function asyncFallback(fn: Function): (done: any) => any {
// If we're running using the Jasmine test framework, adapt to call the 'done'

2
packages/core/testing/src/component_fixture.ts
View File

@ -12,7 +12,7 @@ import {ChangeDetectorRef, ComponentRef, DebugElement, ElementRef, NgZone, Rende
/**
* Fixture for debugging and testing a component.
*
* @stable
*
*/
export class ComponentFixture<T> {
/**

4
packages/core/testing/src/test_bed.ts
View File

@ -55,7 +55,7 @@ export type TestModuleMetadata = {
*
* TestBed is the primary api for writing unit tests for Angular applications and libraries.
*
* @stable
*
*/
export class TestBed implements Injector {
/**
@ -606,7 +606,7 @@ export function getTestBed() {
* eventually
* becomes `it('...', @Inject (object: AClass, async: AsyncTestCompleter) => { ... });`
*
* @stable
*
*/
export function inject(tokens: any[], fn: Function): () => any {
const testBed = getTestBed();