docs: update core to use @publicApi tags (#26595)

PR Close #26595
This commit is contained in:
Pete Bacon Darwin
2018-10-19 16:27:04 +01:00
committed by Alex Rickabaugh
parent 0918adf39d
commit 3903e5ebe7
46 changed files with 179 additions and 139 deletions

View File

@ -43,6 +43,7 @@ function _throwError() {
* that will use the directives/pipes of the ng module for compilation
* of components.
*
* @publicApi
*/
@Injectable()
export class Compiler {

View File

@ -19,6 +19,7 @@ import {ViewRef} from './view_ref';
* Provides access to the component instance and related objects,
* and provides the means of destroying the instance.
*
* @publicApi
*/
export abstract class ComponentRef<C> {
/**
@ -66,6 +67,9 @@ export abstract class ComponentRef<C> {
abstract onDestroy(callback: Function): void;
}
/**
* @publicApi
*/
export abstract class ComponentFactory<C> {
/**
* The comonent's HTML selector.

View File

@ -33,6 +33,9 @@ class _NullComponentFactoryResolver implements ComponentFactoryResolver {
}
}
/**
* @publicApi
*/
export abstract class ComponentFactoryResolver {
static NULL: ComponentFactoryResolver = new _NullComponentFactoryResolver();
abstract resolveComponentFactory<T>(component: Type<T>): ComponentFactory<T>;

View File

@ -19,7 +19,7 @@ import {noop} from '../util/noop';
* XSS attacks. Carefully review any use of `ElementRef` in your code. For more detail, see the
* [Security Guide](http://g.co/ng/security).
*
*
* @publicApi
*/
// 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

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.
*
*
* @publicApi
*/
export abstract class NgModuleRef<T> {
/**

View File

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

View File

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

View File

@ -29,6 +29,7 @@ import {EmbeddedViewRef} from './view_ref';
* @see `ViewContainerRef`
* @see [Navigate the Component Tree with DI](guide/dependency-injection-navtree)
*
* @publicApi
*/
export abstract class TemplateRef<C> {
/**

View File

@ -30,6 +30,7 @@ import {EmbeddedViewRef, ViewRef} from './view_ref';
* @see `ComponentRef`
* @see `EmbeddedViewRef`
*
* @publicApi
*/
export abstract class ViewContainerRef {
/**

View File

@ -16,6 +16,8 @@ import {ChangeDetectorRef} from '../change_detection/change_detector_ref';
* that adds destroy methods for [embedded views](guide/glossary#view-tree).
*
* @see `EmbeddedViewRef`
*
* @publicApi
*/
export abstract class ViewRef extends ChangeDetectorRef {
/**