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

@ -31,7 +31,7 @@ import {
import {resolveForwardRef} from './forward_ref';
/**
* @private
* @internal
*/
export class Dependency {
constructor(public key: Key, public optional: boolean, public lowerBoundVisibility: any,
@ -257,7 +257,7 @@ export class Binding {
*/
export class ResolvedBinding {
/**
* @private
* @internal
*/
constructor(
/**
@ -266,23 +266,23 @@ export class ResolvedBinding {
public key: Key,
/**
* @private
* @internal
* Factory function which can return an instance of an object represented by a key.
*/
public resolvedFactories: ResolvedFactory[],
/**
* @private
* @internal
* Indicates if the binding is a multi-binding or a regular binding.
*/
public multiBinding: boolean) {}
/** @private */
/** @internal */
get resolvedFactory(): ResolvedFactory { return this.resolvedFactories[0]; }
}
/**
* @private
* @internal
* An internal resolved representation of a factory function created by resolving {@link Binding}.
*/
export class ResolvedFactory {

View File

@ -32,16 +32,16 @@ function constructResolvingPath(keys: any[]): string {
* Base class for all errors arising from misconfigured bindings.
*/
export class AbstractBindingError extends BaseException {
/** @private */
/** @internal */
message: string;
/** @private */
/** @internal */
keys: Key[];
/** @private */
/** @internal */
injectors: Injector[];
/** @private */
/** @internal */
constructResolvingMessage: Function;
constructor(injector: Injector, key: Key, constructResolvingMessage: Function) {
@ -135,13 +135,13 @@ export class CyclicDependencyError extends AbstractBindingError {
* ```
*/
export class InstantiationError extends WrappedException {
/** @private */
/** @internal */
keys: Key[];
/** @private */
/** @internal */
injectors: Injector[];
/** @private */
/** @internal */
constructor(injector: Injector, originalException, originalStack, key: Key) {
super("DI Exception", originalException, originalStack, null);
this.keys = [key];
@ -263,4 +263,4 @@ export class MixingMultiBindingsWithRegularBindings extends BaseException {
super("Cannot mix multi bindings and regular bindings, got: " + binding1.toString() + " " +
binding2.toString());
}
}
}

View File

@ -387,7 +387,7 @@ export class BindingWithVisibility {
}
/**
* @private
* @internal
* Used to provide dependencies that cannot be easily expressed as bindings.
*/
export interface DependencyProvider {
@ -537,7 +537,7 @@ export class Injector {
}
/**
* @private
* @internal
*/
debugContext(): any { return this._debugContext(); }
@ -592,7 +592,7 @@ export class Injector {
}
/**
* @private
* @internal
*/
getAt(index: number): any { return this._strategy.getObjAtIndex(index); }
@ -613,7 +613,7 @@ export class Injector {
get parent(): Injector { return this._parent; }
/**
* @private
* @internal
* Internal. Do not use.
* We return `any` not to export the InjectorStrategy type.
*/

View File

@ -46,7 +46,7 @@ export class Key {
}
/**
* @private
* @internal
*/
export class KeyRegistry {
private _allKeys = new Map<Object, Key>();

View File

@ -1,5 +1,5 @@
/**
* @private
* @internal
* Type literals is a Dart-only feature. This is here only so we can x-compile
* to multiple languages.
*/