docs: mark interfaces as public (#30955)

PR Close #30955
This commit is contained in:
Judy Bogart 2019-06-10 10:04:11 -07:00 committed by Kara Erickson
parent 4bd6fca4ef
commit a9502886b1
3 changed files with 27 additions and 20 deletions

View File

@ -20,7 +20,7 @@ export {Injectable, InjectableDecorator, InjectableProvider} from './injectable'
export {Injector} from './injector'; export {Injector} from './injector';
export {ɵɵinject, inject, INJECTOR} from './injector_compatibility'; export {ɵɵinject, inject, INJECTOR} from './injector_compatibility';
export {ReflectiveInjector} from './reflective_injector'; export {ReflectiveInjector} from './reflective_injector';
export {StaticProvider, ValueProvider, ConstructorSansProvider, ExistingProvider, FactoryProvider, Provider, TypeProvider, ClassProvider} from './interface/provider'; export {StaticProvider, ValueProvider, ConstructorSansProvider, ExistingProvider, FactoryProvider, Provider, TypeProvider, ClassProvider, ValueSansProvider, ClassSansProvider} from './interface/provider';
export {ResolvedReflectiveFactory, ResolvedReflectiveProvider} from './reflective_provider'; export {ResolvedReflectiveFactory, ResolvedReflectiveProvider} from './reflective_provider';
export {ReflectiveKey} from './reflective_key'; export {ReflectiveKey} from './reflective_key';
export {InjectionToken} from './injection_token'; export {InjectionToken} from './injection_token';

View File

@ -10,13 +10,7 @@ import {Type} from '../../interface/type';
/** /**
* Configures the `Injector` to return a value for a token. * Configures the `Injector` to return a value for a token.
* * Base for `ValueProvider` decorator.
* For more details, see the ["Dependency Injection Guide"](guide/dependency-injection).
*
* @usageNotes
* ### Example
*
* {@example core/di/ts/provider_spec.ts region='ValueSansProvider'}
* *
* @publicApi * @publicApi
*/ */
@ -33,6 +27,7 @@ export interface ValueSansProvider {
* For more details, see the ["Dependency Injection Guide"](guide/dependency-injection). * For more details, see the ["Dependency Injection Guide"](guide/dependency-injection).
* *
* @usageNotes * @usageNotes
*
* ### Example * ### Example
* *
* {@example core/di/ts/provider_spec.ts region='ValueProvider'} * {@example core/di/ts/provider_spec.ts region='ValueProvider'}
@ -58,13 +53,7 @@ export interface ValueProvider extends ValueSansProvider {
/** /**
* Configures the `Injector` to return an instance of `useClass` for a token. * Configures the `Injector` to return an instance of `useClass` for a token.
* * Base for `StaticClassProvider` decorator.
* For more details, see the ["Dependency Injection Guide"](guide/dependency-injection).
*
* @usageNotes
* ### Example
*
* {@example core/di/ts/provider_spec.ts region='StaticClassSansProvider'}
* *
* @publicApi * @publicApi
*/ */
@ -88,6 +77,7 @@ export interface StaticClassSansProvider {
* For more details, see the ["Dependency Injection Guide"](guide/dependency-injection). * For more details, see the ["Dependency Injection Guide"](guide/dependency-injection).
* *
* @usageNotes * @usageNotes
*
* ### Example * ### Example
* *
* {@example core/di/ts/provider_spec.ts region='StaticClassProvider'} * {@example core/di/ts/provider_spec.ts region='StaticClassProvider'}
@ -99,6 +89,8 @@ export interface StaticClassSansProvider {
* ### Multi-value example * ### Multi-value example
* *
* {@example core/di/ts/provider_spec.ts region='MultiProviderAspect'} * {@example core/di/ts/provider_spec.ts region='MultiProviderAspect'}
*
* @publicApi
*/ */
export interface StaticClassProvider extends StaticClassSansProvider { export interface StaticClassProvider extends StaticClassSansProvider {
/** /**
@ -119,6 +111,7 @@ export interface StaticClassProvider extends StaticClassSansProvider {
* For more details, see the ["Dependency Injection Guide"](guide/dependency-injection). * For more details, see the ["Dependency Injection Guide"](guide/dependency-injection).
* *
* @usageNotes * @usageNotes
*
* ### Example * ### Example
* *
* ``` * ```
@ -142,6 +135,7 @@ export interface ConstructorSansProvider {
* For more details, see the ["Dependency Injection Guide"](guide/dependency-injection). * For more details, see the ["Dependency Injection Guide"](guide/dependency-injection).
* *
* @usageNotes * @usageNotes
*
* ### Example * ### Example
* *
* {@example core/di/ts/provider_spec.ts region='ConstructorProvider'} * {@example core/di/ts/provider_spec.ts region='ConstructorProvider'}
@ -149,6 +143,8 @@ export interface ConstructorSansProvider {
* ### Multi-value example * ### Multi-value example
* *
* {@example core/di/ts/provider_spec.ts region='MultiProviderAspect'} * {@example core/di/ts/provider_spec.ts region='MultiProviderAspect'}
*
* @publicApi
*/ */
export interface ConstructorProvider extends ConstructorSansProvider { export interface ConstructorProvider extends ConstructorSansProvider {
/** /**
@ -169,9 +165,12 @@ export interface ConstructorProvider extends ConstructorSansProvider {
* For more details, see the ["Dependency Injection Guide"](guide/dependency-injection). * For more details, see the ["Dependency Injection Guide"](guide/dependency-injection).
* *
* @usageNotes * @usageNotes
*
* ### Example * ### Example
* *
* {@example core/di/ts/provider_spec.ts region='ExistingSansProvider'} * {@example core/di/ts/provider_spec.ts region='ExistingSansProvider'}
*
* @publicApi
*/ */
export interface ExistingSansProvider { export interface ExistingSansProvider {
/** /**
@ -186,6 +185,7 @@ export interface ExistingSansProvider {
* For more details, see the ["Dependency Injection Guide"](guide/dependency-injection). * For more details, see the ["Dependency Injection Guide"](guide/dependency-injection).
* *
* @usageNotes * @usageNotes
*
* ### Example * ### Example
* *
* {@example core/di/ts/provider_spec.ts region='ExistingProvider'} * {@example core/di/ts/provider_spec.ts region='ExistingProvider'}
@ -241,6 +241,7 @@ export interface FactorySansProvider {
* For more details, see the ["Dependency Injection Guide"](guide/dependency-injection). * For more details, see the ["Dependency Injection Guide"](guide/dependency-injection).
* *
* @usageNotes * @usageNotes
*
* ### Example * ### Example
* *
* {@example core/di/ts/provider_spec.ts region='FactoryProvider'} * {@example core/di/ts/provider_spec.ts region='FactoryProvider'}
@ -292,6 +293,7 @@ export type StaticProvider = ValueProvider | ExistingProvider | StaticClassProvi
* For more details, see the ["Dependency Injection Guide"](guide/dependency-injection). * For more details, see the ["Dependency Injection Guide"](guide/dependency-injection).
* *
* @usageNotes * @usageNotes
*
* ### Example * ### Example
* *
* {@example core/di/ts/provider_spec.ts region='TypeProvider'} * {@example core/di/ts/provider_spec.ts region='TypeProvider'}
@ -302,14 +304,10 @@ export interface TypeProvider extends Type<any> {}
/** /**
* Configures the `Injector` to return a value by invoking a `useClass` function. * Configures the `Injector` to return a value by invoking a `useClass` function.
* Base for `ClassProvider` decorator.
* *
* For more details, see the ["Dependency Injection Guide"](guide/dependency-injection). * For more details, see the ["Dependency Injection Guide"](guide/dependency-injection).
* *
* @usageNotes
* ### Example
*
* {@example core/di/ts/provider_spec.ts region='ClassSansProvider'}
*
* @publicApi * @publicApi
*/ */
export interface ClassSansProvider { export interface ClassSansProvider {
@ -325,6 +323,7 @@ export interface ClassSansProvider {
* For more details, see the ["Dependency Injection Guide"](guide/dependency-injection). * For more details, see the ["Dependency Injection Guide"](guide/dependency-injection).
* *
* @usageNotes * @usageNotes
*
* ### Example * ### Example
* *
* {@example core/di/ts/provider_spec.ts region='ClassProvider'} * {@example core/di/ts/provider_spec.ts region='ClassProvider'}

View File

@ -80,6 +80,10 @@ export interface ClassProvider extends ClassSansProvider {
provide: any; provide: any;
} }
export interface ClassSansProvider {
useClass: Type<any>;
}
/** @deprecated */ /** @deprecated */
export interface CollectionChangeRecord<V> extends IterableChangeRecord<V> { export interface CollectionChangeRecord<V> extends IterableChangeRecord<V> {
} }
@ -1386,6 +1390,10 @@ export interface ValueProvider extends ValueSansProvider {
provide: any; provide: any;
} }
export interface ValueSansProvider {
useValue: any;
}
export declare class Version { export declare class Version {
full: string; full: string;
readonly major: string; readonly major: string;