chore(docs): rename @private to @internal

The latter is understood by TypeScript's --stripInternal option, so this lets us
rely more on the tooling provided by typescript team.
This commit is contained in:
Alex Eagle
2015-10-02 13:32:48 -07:00
parent 4a36fd8203
commit f7aa890ade
38 changed files with 98 additions and 94 deletions

View File

@ -18,7 +18,7 @@ import {CompiledHostTemplate} from 'angular2/src/core/linker/template_commands';
@Injectable()
export class Compiler {
/**
* @private
* @internal
*/
constructor(private _protoViewFactory: ProtoViewFactory) {}

View File

@ -32,7 +32,7 @@ export class ComponentRef {
componentType: Type;
/**
* @private
* @internal
*
* The injector provided {@link DynamicComponentLoader#loadAsRoot}.
*
@ -42,7 +42,7 @@ export class ComponentRef {
injector: Injector;
/**
* @private
* @internal
*
* TODO(i): refactor into public/private fields
*/
@ -60,7 +60,7 @@ export class ComponentRef {
get hostView(): HostViewRef { return this.location.parentView; }
/**
* @private
* @internal
*
* Returns the type of this Component instance.
*
@ -69,7 +69,7 @@ export class ComponentRef {
get hostComponentType(): Type { return this.componentType; }
/**
* @private
* @internal
*
* The instance of the component.
*
@ -91,7 +91,7 @@ export class ComponentRef {
@Injectable()
export class DynamicComponentLoader {
/**
* @private
* @internal
*/
constructor(private _compiler: Compiler, private _viewManager: AppViewManager) {}

View File

@ -14,7 +14,7 @@ import {RenderViewRef, RenderElementRef, Renderer} from 'angular2/src/core/rende
*/
export class ElementRef implements RenderElementRef {
/**
* @private
* @internal
*
* Reference to the {@link ViewRef} that this `ElementRef` is part of.
*/
@ -22,7 +22,7 @@ export class ElementRef implements RenderElementRef {
/**
* @private
* @internal
*
* Index of the element inside the {@link ViewRef}.
*
@ -30,7 +30,7 @@ export class ElementRef implements RenderElementRef {
*/
boundElementIndex: number;
/**
* @private
* @internal
*/
constructor(parentView: ViewRef, boundElementIndex: number, private _renderer: Renderer) {
this.parentView = parentView;
@ -38,7 +38,7 @@ export class ElementRef implements RenderElementRef {
}
/**
* @private
* @internal
*/
get renderView(): RenderViewRef { return this.parentView.render; }

View File

@ -2,7 +2,7 @@ import {MapWrapper} from 'angular2/src/core/facade/collection';
import {SimpleChange} from 'angular2/src/core/change_detection/change_detection_util';
/**
* @private
* @internal
*/
export enum LifecycleHooks {
OnInit,
@ -16,7 +16,7 @@ export enum LifecycleHooks {
}
/**
* @private
* @internal
*/
export var LIFECYCLE_HOOKS_VALUES = [
LifecycleHooks.OnInit,

View File

@ -27,12 +27,12 @@ class QueryList<T> extends Object
return this._results.map(fn).toList();
}
/** @private */
/** @internal */
void reset(List<T> newList) {
_results = newList;
}
/** @private */
/** @internal */
void notifyOnChanges() {
_emitter.add(this);
}

View File

@ -46,10 +46,10 @@ export class QueryList<T> {
toString(): string { return this._results.toString(); }
/**
* @private
* @internal
*/
reset(res: T[]): void { this._results = res; }
/** @private */
/** @internal */
notifyOnChanges(): void { this._emitter.next(this); }
}

View File

@ -30,7 +30,7 @@ export class TemplateRef {
elementRef: ElementRef;
/**
* @private
* @internal
*/
constructor(elementRef: ElementRef) { this.elementRef = elementRef; }
@ -42,7 +42,7 @@ export class TemplateRef {
}
/**
* @private
* @internal
*
* Reference to the ProtoView used for creating Embedded Views that are based on the compiled
* Embedded Template.

View File

@ -31,11 +31,11 @@ import {ViewRef, HostViewRef, ProtoViewRef, internalView} from './view_ref';
*/
export class ViewContainerRef {
/**
* @private
* @internal
*/
constructor(
/**
* @private
* @internal
*/
public viewManager: avmModule.AppViewManager,

View File

@ -35,7 +35,7 @@ import {ProtoViewFactory} from './proto_view_factory';
export class AppViewManager {
private _protoViewFactory: ProtoViewFactory;
/**
* @private
* @internal
*/
constructor(private _viewPool: AppViewPool, private _viewListener: AppViewListener,
private _utils: AppViewManagerUtils, private _renderer: Renderer,

View File

@ -25,7 +25,7 @@ export function internalProtoView(protoViewRef: ProtoViewRef): viewModule.AppPro
*/
export interface HostViewRef {
/**
* @private
* @internal
*/
changeDetectorRef: ChangeDetectorRef;
}
@ -87,26 +87,26 @@ export class ViewRef implements HostViewRef {
private _changeDetectorRef: ChangeDetectorRef = null;
/**
* @private
* @internal
*/
constructor(public _view: viewModule.AppView) {}
/**
* @private
* @internal
*
* Return `RenderViewRef`
*/
get render(): RenderViewRef { return this._view.render; }
/**
* @private
* @internal
*
* Return `RenderFragmentRef`
*/
get renderFragment(): RenderFragmentRef { return this._view.renderFragment; }
/**
* @private
* @internal
*
* Return `ChangeDetectorRef`
*/
@ -167,7 +167,7 @@ export class ViewRef implements HostViewRef {
*/
export class ProtoViewRef {
/**
* @private
* @internal
*/
constructor(public _protoView: viewModule.AppProtoView) {}
}