chore(doc-gen): remove unnecessary `@public` and `@exportedAs` tags

This commit is contained in:
Peter Bacon Darwin 2015-07-11 07:21:21 +01:00
parent 9fa7d38133
commit 2e4a2a0e5a
83 changed files with 5 additions and 299 deletions

View File

@ -134,10 +134,10 @@ You can selectively build either the JS or Dart versions as follows:
* `$(npm bin)/gulp build.js`
* `$(npm bin)/gulp build.dart`
Also note that in order for the whole test suite to succeed you will need to generate the docs by running:
Also note that in order for the whole test suite to succeed you will need to generate the type definitions by running:
```shell
$(npm bin)/gulp docs
$(npm bin)/gulp docs/typings
```
To clean out the `dist` folder, run:

View File

@ -48,9 +48,7 @@ module.exports = new Package('angular-v2-docs', [jsdocPackage, nunjucksPackage,
.config(function(parseTagsProcessor, getInjectables) {
parseTagsProcessor.tagDefinitions.push(require('./tag-defs/public'));
parseTagsProcessor.tagDefinitions.push(require('./tag-defs/private'));
parseTagsProcessor.tagDefinitions.push(require('./tag-defs/exportedAs'));
// We actually don't want to parse param docs in this package as we are getting the data out using TS
parseTagsProcessor.tagDefinitions.forEach(function(tagDef) {

View File

@ -1,4 +0,0 @@
module.exports = {
name: 'exportedAs',
multi: true
};

View File

@ -1,4 +0,0 @@
module.exports = {
name: 'public',
transforms: function(doc, tag) { return true; }
};

View File

@ -46,9 +46,7 @@ module.exports = new Package('angular-v2-docs', [jsdocPackage, nunjucksPackage,
.config(function(parseTagsProcessor, getInjectables) {
parseTagsProcessor.tagDefinitions.push(require('./tag-defs/public'));
parseTagsProcessor.tagDefinitions.push(require('./tag-defs/private'));
parseTagsProcessor.tagDefinitions.push(require('./tag-defs/exportedAs'));
// We actually don't want to parse param docs in this package as we are getting the data out using TS
parseTagsProcessor.tagDefinitions.forEach(function(tagDef) {

View File

@ -1,4 +0,0 @@
module.exports = {
name: 'exportedAs',
multi: true
};

View File

@ -1,4 +0,0 @@
module.exports = {
name: 'public',
transforms: function(doc, tag) { return true; }
};

View File

@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
*
* Annotations provide the additional information that Angular requires in order to run your

View File

@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* Change detection enables data binding in Angular.
*/

View File

@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* Define angular core API here.
*/

View File

@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* The `di` module provides dependency injection container services.
*/

View File

@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* Errors thrown by the {@link Injector}.
*/

View File

@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* Metadata which control how the dependencies are resolved by the {@link Injector}.
*/

View File

@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* Common directives shipped with Angular.
*/

View File

@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* This module is used for handling user input, by defining and building a {@link ControlGroup} that
* consists of

View File

@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* The http module provides services to perform http requests. To get started, see the {@link Http}
* class.

View File

@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* This module provides advanced support for extending change detection.
*/

View File

@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* This module provides advanced support for extending dom strategy.
*/

View File

@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* Maps application URLs into application states, to support deep-linking and navigation.
*/

View File

@ -21,24 +21,18 @@ import {CONST, CONST_EXPR, isPresent, BaseException} from 'angular2/src/facade/l
/**
* Structural diffing for `Object`s and `Map`s.
*
* @exportedAs angular2/pipes
*/
export const keyValDiff: List<PipeFactory> =
CONST_EXPR([CONST_EXPR(new KeyValueChangesFactory()), CONST_EXPR(new NullPipeFactory())]);
/**
* Structural diffing for `Iterable` types such as `Array`s.
*
* @exportedAs angular2/pipes
*/
export const iterableDiff: List<PipeFactory> =
CONST_EXPR([CONST_EXPR(new IterableChangesFactory()), CONST_EXPR(new NullPipeFactory())]);
/**
* Async binding to such types as Observable.
*
* @exportedAs angular2/pipes
*/
export const async: List<PipeFactory> = CONST_EXPR([
CONST_EXPR(new ObservablePipeFactory()),
@ -48,64 +42,48 @@ export const async: List<PipeFactory> = CONST_EXPR([
/**
* Uppercase text transform.
*
* @exportedAs angular2/pipes
*/
export const uppercase: List<PipeFactory> =
CONST_EXPR([CONST_EXPR(new UpperCaseFactory()), CONST_EXPR(new NullPipeFactory())]);
/**
* Lowercase text transform.
*
* @exportedAs angular2/pipes
*/
export const lowercase: List<PipeFactory> =
CONST_EXPR([CONST_EXPR(new LowerCaseFactory()), CONST_EXPR(new NullPipeFactory())]);
/**
* Json stringify transform.
*
* @exportedAs angular2/pipes
*/
export const json: List<PipeFactory> =
CONST_EXPR([CONST_EXPR(new JsonPipe()), CONST_EXPR(new NullPipeFactory())]);
/**
* LimitTo text transform.
*
* @exportedAs angular2/pipes
*/
export const limitTo: List<PipeFactory> =
CONST_EXPR([CONST_EXPR(new LimitToPipeFactory()), CONST_EXPR(new NullPipeFactory())]);
/**
* Number number transform.
*
* @exportedAs angular2/pipes
*/
export const decimal: List<PipeFactory> =
CONST_EXPR([CONST_EXPR(new DecimalPipe()), CONST_EXPR(new NullPipeFactory())]);
/**
* Percent number transform.
*
* @exportedAs angular2/pipes
*/
export const percent: List<PipeFactory> =
CONST_EXPR([CONST_EXPR(new PercentPipe()), CONST_EXPR(new NullPipeFactory())]);
/**
* Currency number transform.
*
* @exportedAs angular2/pipes
*/
export const currency: List<PipeFactory> =
CONST_EXPR([CONST_EXPR(new CurrencyPipe()), CONST_EXPR(new NullPipeFactory())]);
/**
* Date/time formatter.
*
* @exportedAs angular2/pipes
*/
export const date: List<PipeFactory> =
CONST_EXPR([CONST_EXPR(new DatePipe()), CONST_EXPR(new NullPipeFactory())]);
@ -138,8 +116,6 @@ export const PROTO_CHANGE_DETECTOR_KEY = CONST_EXPR(new OpaqueToken('ProtoChange
/**
* Implements change detection using a map of pregenerated proto detectors.
*
* @exportedAs angular2/change_detection
*/
@Injectable()
export class PreGeneratedChangeDetection extends ChangeDetection {
@ -171,8 +147,6 @@ export class PreGeneratedChangeDetection extends ChangeDetection {
* Implements change detection that does not require `eval()`.
*
* This is slower than {@link JitChangeDetection}.
*
* @exportedAs angular2/change_detection
*/
@Injectable()
export class DynamicChangeDetection extends ChangeDetection {
@ -186,8 +160,6 @@ export class DynamicChangeDetection extends ChangeDetection {
*
* This requires `eval()`. For change detection that does not require `eval()`, see
* {@link DynamicChangeDetection} and {@link PreGeneratedChangeDetection}.
*
* @exportedAs angular2/change_detection
*/
@Injectable()
@CONST()

View File

@ -7,8 +7,6 @@ import {CHECK_ONCE, DETACHED, CHECK_ALWAYS} from './constants';
* {@link ChangeDetectorRef} allows requesting checks for detectors that rely on observables. It
*also allows detaching and
* attaching change detector subtrees.
*
* @exportedAs angular2/change_detection
*/
export class ChangeDetectorRef {
constructor(private _cd: ChangeDetector) {}

View File

@ -28,7 +28,6 @@ import {DirectiveRecord} from './directive_record';
* ```javascript
* bootstrap(MyApp, [bind(ChangeDetection).toClass(DynamicChangeDetection)]);
* ```
* @exportedAs angular2/change_detection
*/
@CONST()
export class ChangeDetection {

View File

@ -68,8 +68,6 @@ var defaultLocale: string = 'en-US';
* {{ dateObj | date:'medium' }} // output is 'Jun 15, 2015, 9:43:11 PM'
* {{ dateObj | date:'shortTime' }} // output is '9:43 PM'
* {{ dateObj | date:'mmss' }} // output is '43:11'
*
* @exportedAs angular2/pipes
*/
@CONST()
export class DatePipe extends BasePipe implements PipeFactory {

View File

@ -25,9 +25,6 @@ export class IterableChangesFactory implements PipeFactory {
create(cdRef: ChangeDetectorRef): Pipe { return new IterableChanges(); }
}
/**
* @exportedAs angular2/pipes
*/
export class IterableChanges extends BasePipe {
private _collection = null;
private _length: int = null;
@ -475,9 +472,6 @@ export class IterableChanges extends BasePipe {
}
}
/**
* @exportedAs angular2/pipes
*/
export class CollectionChangeRecord {
currentIndex: int = null;
previousIndex: int = null;

View File

@ -24,8 +24,6 @@ import {ChangeDetectorRef} from '../change_detector_ref';
* }
*
* ```
*
* @exportedAs angular2/pipes
*/
@CONST()
export class JsonPipe extends BasePipe implements PipeFactory {

View File

@ -3,9 +3,6 @@ import {stringify, looseIdentical, isJsObject, CONST} from 'angular2/src/facade/
import {ChangeDetectorRef} from '../change_detector_ref';
import {WrappedValue, BasePipe, Pipe, PipeFactory} from './pipe';
/**
* @exportedAs angular2/pipes
*/
@CONST()
export class KeyValueChangesFactory implements PipeFactory {
supports(obj): boolean { return KeyValueChanges.supportsObj(obj); }
@ -13,9 +10,6 @@ export class KeyValueChangesFactory implements PipeFactory {
create(cdRef: ChangeDetectorRef): Pipe { return new KeyValueChanges(); }
}
/**
* @exportedAs angular2/pipes
*/
export class KeyValueChanges extends BasePipe {
private _records: Map<any, any> = new Map();
private _mapHead: KVChangeRecord = null;
@ -327,10 +321,6 @@ export class KeyValueChanges extends BasePipe {
}
/**
* @exportedAs angular2/pipes
*/
export class KVChangeRecord {
previousValue: any = null;
currentValue: any = null;

View File

@ -49,8 +49,6 @@ import {ChangeDetectorRef} from '../change_detector_ref';
* {{ 'abcdefghij' | limitTo: 4 }} // output is 'abcd'
* {{ 'abcdefghij' | limitTo: -4 }} // output is 'ghij'
* {{ 'abcdefghij' | limitTo: -100 }} // output is 'abcdefghij'
*
* @exportedAs angular2/pipes
*/
export class LimitToPipe implements Pipe {
static supportsObj(obj): boolean { return isString(obj) || isArray(obj); }
@ -76,9 +74,6 @@ export class LimitToPipe implements Pipe {
onDestroy(): void {}
}
/**
* @exportedAs angular2/pipes
*/
@CONST()
export class LimitToPipeFactory implements PipeFactory {
supports(obj): boolean { return LimitToPipe.supportsObj(obj); }

View File

@ -21,8 +21,6 @@ import {ChangeDetectorRef} from '../change_detector_ref';
* }
*
* ```
*
* @exportedAs angular2/pipes
*/
export class LowerCasePipe implements Pipe {
_latestValue: string = null;
@ -41,9 +39,6 @@ export class LowerCasePipe implements Pipe {
}
}
/**
* @exportedAs angular2/pipes
*/
@CONST()
export class LowerCaseFactory implements PipeFactory {
supports(str): boolean { return isString(str); }

View File

@ -2,9 +2,6 @@ import {isBlank, CONST} from 'angular2/src/facade/lang';
import {Pipe, BasePipe, WrappedValue, PipeFactory} from './pipe';
import {ChangeDetectorRef} from '../change_detector_ref';
/**
* @exportedAs angular2/pipes
*/
@CONST()
export class NullPipeFactory implements PipeFactory {
supports(obj): boolean { return NullPipe.supportsObj(obj); }
@ -12,9 +9,6 @@ export class NullPipeFactory implements PipeFactory {
create(cdRef: ChangeDetectorRef): Pipe { return new NullPipe(); }
}
/**
* @exportedAs angular2/pipes
*/
export class NullPipe extends BasePipe {
called: boolean = false;

View File

@ -75,8 +75,6 @@ export class NumberPipe extends BasePipe implements PipeFactory {
* {{ 123 | number }} // output is 123
* {{ 123.1 | number: '.2-3' }} // output is 123.10
* {{ 1 | number: '2.2' }} // output is 01.00
*
* @exportedAs angular2/pipes
*/
@CONST()
export class DecimalPipe extends NumberPipe {
@ -94,8 +92,6 @@ export class DecimalPipe extends NumberPipe {
* expression | percent[:digitInfo]
*
* For more information about `digitInfo` see {@link DecimalPipe}
*
* @exportedAs angular2/pipes
*/
@CONST()
export class PercentPipe extends NumberPipe {
@ -117,8 +113,6 @@ export class PercentPipe extends NumberPipe {
* symbol (e.g. $) or the currency code (e.g. USD) in the output. The default for this value
* is `false`.
* For more information about `digitInfo` see {@link DecimalPipe}
*
* @exportedAs angular2/pipes
*/
@CONST()
export class CurrencyPipe extends NumberPipe {

View File

@ -26,8 +26,6 @@ import {ChangeDetectorRef} from '../change_detector_ref';
* }
*
* ```
*
* @exportedAs angular2/pipes
*/
export class ObservablePipe implements Pipe {
_latestValue: Object = null;
@ -87,8 +85,6 @@ export class ObservablePipe implements Pipe {
/**
* Provides a factory for [ObervablePipe].
*
* @exportedAs angular2/pipes
*/
@CONST()
export class ObservablePipeFactory implements PipeFactory {

View File

@ -6,8 +6,6 @@ import {ChangeDetectorRef} from '../change_detector_ref';
*has not changed.
*
* The wrapped value will be unwrapped by change detection, and the unwrapped value will be stored.
*
* @exportedAs angular2/pipes
*/
export class WrappedValue {
constructor(public wrapped: any) {}
@ -49,8 +47,6 @@ var _wrappedIndex = 0;
* }
* }
* ```
*
* @exportedAs angular2/pipes
*/
export interface Pipe {
supports(obj): boolean;

View File

@ -25,8 +25,6 @@ import {ChangeDetectorRef} from '../change_detector_ref';
* }
*
* ```
*
* @exportedAs angular2/pipes
*/
export class PromisePipe implements Pipe {
_latestValue: Object = null;
@ -77,8 +75,6 @@ export class PromisePipe implements Pipe {
/**
* Provides a factory for [PromisePipe].
*
* @exportedAs angular2/pipes
*/
@CONST()
export class PromisePipeFactory implements PipeFactory {

View File

@ -21,8 +21,6 @@ import {ChangeDetectorRef} from '../change_detector_ref';
* }
*
* ```
*
* @exportedAs angular2/pipes
*/
export class UpperCasePipe implements Pipe {
_latestValue: string = null;
@ -41,9 +39,6 @@ export class UpperCasePipe implements Pipe {
}
}
/**
* @exportedAs angular2/pipes
*/
@CONST()
export class UpperCaseFactory implements PipeFactory {
supports(str): boolean { return isString(str); }

View File

@ -403,8 +403,6 @@ import {DEFAULT} from 'angular2/change_detection';
* Note also that although the `<li></li>` template still exists inside the `<template></template>`,
* the instantiated
* view occurs on the second `<li></li>` which is a sibling to the `<template>` element.
*
* @exportedAs angular2/annotations
*/
@CONST()
export class Directive extends InjectableMetadata {
@ -841,8 +839,6 @@ export class Directive extends InjectableMetadata {
* }
* ```
*
*
* @exportedAs angular2/annotations
*/
@CONST()
export class Component extends Directive {
@ -958,7 +954,6 @@ export class LifecycleEvent {
* }
* }
* ```
* @exportedAs angular2/annotations
*/
export const onDestroy: LifecycleEvent = CONST_EXPR(new LifecycleEvent("onDestroy"));
@ -996,7 +991,6 @@ export const onDestroy: LifecycleEvent = CONST_EXPR(new LifecycleEvent("onDestro
* }
* }
* ```
* @exportedAs angular2/annotations
*/
export const onChange: LifecycleEvent = CONST_EXPR(new LifecycleEvent("onChange"));
@ -1020,7 +1014,6 @@ export const onChange: LifecycleEvent = CONST_EXPR(new LifecycleEvent("onChange"
* }
* }
* ```
* @exportedAs angular2/annotations
*/
export const onCheck: LifecycleEvent = CONST_EXPR(new LifecycleEvent("onCheck"));
@ -1044,7 +1037,6 @@ export const onCheck: LifecycleEvent = CONST_EXPR(new LifecycleEvent("onCheck"))
* }
* }
* ```
* @exportedAs angular2/annotations
*/
export const onInit: LifecycleEvent = CONST_EXPR(new LifecycleEvent("onInit"));
@ -1066,6 +1058,5 @@ export const onInit: LifecycleEvent = CONST_EXPR(new LifecycleEvent("onInit"));
*
* }
* ```
* @exportedAs angular2/annotations
*/
export const onAllChangesDone: LifecycleEvent = CONST_EXPR(new LifecycleEvent("onAllChangesDone"));

View File

@ -27,8 +27,6 @@ import {resolveForwardRef} from 'angular2/di';
* }
* }
* ```
*
* @exportedAs angular2/annotations
*/
@CONST()
export class Attribute extends DependencyMetadata {
@ -49,8 +47,6 @@ export class Attribute extends DependencyMetadata {
* Specifies that a {@link QueryList} should be injected.
*
* See {@link QueryList} for usage and example.
*
* @exportedAs angular2/annotations
*/
@CONST()
export class Query extends DependencyMetadata {

View File

@ -30,8 +30,6 @@ import {ABSTRACT, CONST, Type} from 'angular2/src/facade/lang';
* }
* }
* ```
*
* @exportedAs angular2/annotations
*/
@CONST()
export class View {

View File

@ -275,8 +275,6 @@ function _createNgZone(givenReporter: Function): NgZone {
* unhandled exceptions.
*
* Returns a `Promise` of {@link ApplicationRef}.
*
* @exportedAs angular2/core
*/
export function bootstrap(appComponentType: Type,
componentInjectableBindings: List<Type | Binding | List<any>> = null,

View File

@ -6,8 +6,6 @@ import {List, ListWrapper, MapWrapper} from 'angular2/src/facade/collection';
*
* In the future this class will implement an Observable interface.
* For now it uses a plain list of observable callbacks.
*
* @exportedAs angular2/view
*/
export class BaseQueryList<T> {
protected _results: List<T> = [];

View File

@ -79,8 +79,6 @@ export class CompilerCache {
* var componentResolvedUrl = urlResolver.resolve(appRootUrl.value, componentUrl);
* var templateResolvedUrl = urlResolver.resolve(componetResolvedUrl, url);
* ```
*
* @exportedAs angular2/view
*/
@Injectable()
export class Compiler {

View File

@ -6,9 +6,6 @@ import {AppViewManager} from 'angular2/src/core/compiler/view_manager';
import {ElementRef} from './element_ref';
import {ViewRef} from './view_ref';
/**
* @exportedAs angular2/view
*/
export class ComponentRef {
constructor(public location: ElementRef, public instance: any, public dispose: Function) {}
@ -18,8 +15,6 @@ export class ComponentRef {
/**
* Service for dynamically loading a Component into an arbitrary position in the internal Angular
* application tree.
*
* @exportedAs angular2/view
*/
@Injectable()
export class DynamicComponentLoader {

View File

@ -9,8 +9,6 @@ import {RenderViewRef, RenderElementRef, Renderer} from 'angular2/src/render/api
* a Browser, but may represent other types on other rendering platforms. In the browser the
* `ElementRef` can be sent to the web-worker. Web Workers can not have references to the
* DOM Elements.
*
* @exportedAs angular2/view
*/
export class ElementRef implements RenderElementRef {
/**

View File

@ -72,8 +72,6 @@ import {BaseQueryList} from './base_query_list';
* title:string;
* }
* ```
*
* @exportedAs angular2/view
*/
export class QueryList<T> extends BaseQueryList<T> {
/**

View File

@ -7,9 +7,7 @@ import * as viewModule from './view';
import {ElementRef} from './element_ref';
import {ViewRef, ProtoViewRef, internalView} from './view_ref';
/**
* @exportedAs angular2/core
*/
export class ViewContainerRef {
constructor(public viewManager: avmModule.AppViewManager, public element: ElementRef) {}

View File

@ -62,8 +62,6 @@ export function internalProtoView(protoViewRef: ProtoViewRef): viewModule.AppPro
* </ul>
* <!-- /ViewRef: outter-0 -->
* ```
*
* @exportedAs angular2/view
*/
export class ViewRef {
constructor(public _view: viewModule.AppView) {}
@ -116,8 +114,6 @@ export class ViewRef {
* ```
*
* Notice that the original template is broken down into two separate {@link ProtoViewRef}s.
*
* @exportedAs angular2/view
*/
export class ProtoViewRef {
/**

View File

@ -30,8 +30,6 @@ import {DOM} from 'angular2/src/dom/dom_adapter';
* }
*
* ```
*
* @exportedAs angular2/core
*/
@Injectable()
export class ExceptionHandler {

View File

@ -29,7 +29,6 @@ import {isPresent, BaseException} from 'angular2/src/facade/lang';
* lifecycle.tick();
* });
* ```
* @exportedAs angular2/change_detection
*/
@Injectable()
export class LifeCycle {

View File

@ -11,8 +11,6 @@ export interface NgZoneZone extends Zone { _innerZone: boolean; }
*
* A typical application will create a singleton `NgZone`. The outer `Zone` is a fork of the root
* `Zone`. The default `onTurnDone` runs the Angular change detection.
*
* @exportedAs angular2/core
*/
export class NgZone {
// Code executed in _mountZone does not trigger the onTurnDone.

View File

@ -9,8 +9,6 @@ import {internalView} from 'angular2/src/core/compiler/view_ref';
import {ElementRef} from 'angular2/src/core/compiler/element_ref';
/**
* @exportedAs angular2/test
*
* A DebugElement contains information from the Angular compiler about an
* element and provides access to the corresponding ElementInjector and
* underlying dom Element, as well as a way to query for children.
@ -149,9 +147,6 @@ export function asNativeElements(arr: List<DebugElement>): List<any> {
return arr.map((debugEl) => debugEl.nativeElement);
}
/**
* @exportedAs angular2/test
*/
export class Scope {
static all(debugElement): List<DebugElement> {
var scope = [];
@ -185,9 +180,6 @@ export class Scope {
}
}
/**
* @exportedAs angular2/test
*/
export class By {
static all(): Function { return (debugElement) => true; }

View File

@ -50,8 +50,6 @@ const _EMPTY_LIST = CONST_EXPR([]);
*
* expect(injector.get(String)).toEqual('Hello');
* ```
*
* @exportedAs angular2/di
*/
@CONST()
export class Binding {
@ -228,8 +226,6 @@ export class Binding {
* A {@link Binding} is resolved when it has a factory function. Binding to a class, alias, or
* value, are just convenience methods, as {@link Injector} only operates on calling factory
* functions.
*
* @exportedAs angular2/di
*/
export class ResolvedBinding {
constructor(
@ -260,8 +256,6 @@ export class ResolvedBinding {
* bind(MyInterface).toClass(MyClass)
*
* ```
*
* @exportedAs angular2/di
*/
export function bind(token): BindingBuilder {
return new BindingBuilder(token);
@ -269,8 +263,6 @@ export function bind(token): BindingBuilder {
/**
* Helper class for the {@link bind} function.
*
* @exportedAs angular2/di
*/
export class BindingBuilder {
constructor(public token) {}

View File

@ -27,8 +27,6 @@ function constructResolvingPath(keys: List<any>): string {
/**
* Base class for all errors arising from misconfigured bindings.
*
* @exportedAs angular2/di_errors
*/
export class AbstractBindingError extends BaseException {
name: string;
@ -55,8 +53,6 @@ export class AbstractBindingError extends BaseException {
/**
* Thrown when trying to retrieve a dependency by `Key` from {@link Injector}, but the
* {@link Injector} does not have a {@link Binding} for {@link Key}.
*
* @exportedAs angular2/di_errors
*/
export class NoBindingError extends AbstractBindingError {
// TODO(tbosch): Can't do key:Key as this results in a circular dependency!
@ -89,8 +85,6 @@ export class NoBindingError extends AbstractBindingError {
*
* The above example throws because `String` depends on `Number` which is async. If any binding in
* the dependency graph is async then the graph can only be retrieved using the `asyncGet` API.
*
* @exportedAs angular2/di_errors
*/
export class AsyncBindingError extends AbstractBindingError {
// TODO(tbosch): Can't do key:Key as this results in a circular dependency!
@ -117,8 +111,6 @@ export class AsyncBindingError extends AbstractBindingError {
* ```
*
* Retrieving `A` or `B` throws a `CyclicDependencyError` as the graph above cannot be constructed.
*
* @exportedAs angular2/di_errors
*/
export class CyclicDependencyError extends AbstractBindingError {
// TODO(tbosch): Can't do key:Key as this results in a circular dependency!
@ -134,8 +126,6 @@ export class CyclicDependencyError extends AbstractBindingError {
*
* The `InstantiationError` class contains the original error plus the dependency graph which caused
* this object to be instantiated.
*
* @exportedAs angular2/di_errors
*/
export class InstantiationError extends AbstractBindingError {
causeKey;
@ -156,8 +146,6 @@ export class InstantiationError extends AbstractBindingError {
/**
* Thrown when an object other then {@link Binding} (or `Type`) is passed to {@link Injector}
* creation.
*
* @exportedAs angular2/di_errors
*/
export class InvalidBindingError extends BaseException {
message: string;
@ -175,8 +163,6 @@ export class InvalidBindingError extends BaseException {
*
* Lack of annotation information prevents the {@link Injector} from determining which dependencies
* need to be injected into the constructor.
*
* @exportedAs angular2/di_errors
*/
export class NoAnnotationError extends BaseException {
name: string;
@ -202,8 +188,6 @@ export class NoAnnotationError extends BaseException {
/**
* Thrown when getting an object by index.
*
* @exportedAs angular2/di_errors
*/
export class OutOfBoundsError extends BaseException {
message: string;

View File

@ -11,7 +11,5 @@ forwardRef(ForwardRefFn forwardRefFn) => forwardRefFn();
* Lazily retrieve the reference value.
*
* See: {@link forwardRef}
*
* @exportedAs angular2/di
*/
resolveForwardRef(type) => type;

View File

@ -25,8 +25,6 @@ export interface ForwardRefFn { (): any; }
* class Lock {
* }
* ```
*
* @exportedAs angular2/di
*/
export function forwardRef(forwardRefFn: ForwardRefFn): Type {
(<any>forwardRefFn).__forward_ref__ = forwardRef;
@ -38,8 +36,6 @@ export function forwardRef(forwardRefFn: ForwardRefFn): Type {
* Lazily retrieve the reference value.
*
* See: {@link forwardRef}
*
* @exportedAs angular2/di
*/
export function resolveForwardRef(type: any): any {
if (isFunction(type) && type.hasOwnProperty('__forward_ref__') &&

View File

@ -446,8 +446,6 @@ export interface DependencyProvider {
* ```
* Notice that we don't use the `new` operator because we explicitly want to have the `Injector`
* resolve all of the object's dependencies automatically.
*
* @exportedAs angular2/di
*/
export class Injector {
/**

View File

@ -14,8 +14,6 @@ export {TypeLiteral} from './type_literal';
*
* Keys are used internally by the {@link Injector} because their system-wide unique `id`s allow the
* injector to index in arrays rather than looking up items in maps.
*
* @exportedAs angular2/di
*/
export class Key {
/**

View File

@ -8,8 +8,6 @@ import {CONST, CONST_EXPR, stringify, isBlank, isPresent} from "angular2/src/fac
* constructor(@Inject(MyService) aService:MyService) {}
* }
* ```
*
* @exportedAs angular2/di_metadata
*/
@CONST()
@ -29,8 +27,6 @@ export class InjectMetadata {
* }
* }
* ```
*
* @exportedAs angular2/di_metadata
*/
@CONST()
export class OptionalMetadata {
@ -62,8 +58,6 @@ export class OptionalMetadata {
*
* The framework can use `new Parent()` to handle the `aService` dependency
* in a specific way.
*
* @exportedAs angular2/di_metadata
*/
@CONST()
export class DependencyMetadata {
@ -82,7 +76,6 @@ export class DependencyMetadata {
* @Injectable
* class UsefulService {}
* ```
* @exportedAs angular2/di_metadata
*/
@CONST()
export class InjectableMetadata {
@ -93,8 +86,6 @@ export class InjectableMetadata {
* Specifies how injector should resolve a dependency.
*
* See {@link Self}, {@link Parent}, {@link Ancestor}, {@link Unbounded}.
*
* @exportedAs angular2/di_metadata
*/
@CONST()
export class VisibilityMetadata {
@ -125,8 +116,6 @@ export class VisibilityMetadata {
* var nd = inj.get(NeedsDependency);
* expect(nd.dependency).toBeAnInstanceOf(Dependency);
* ```
*
* @exportedAs angular2/di
*/
@CONST()
export class SelfMetadata extends VisibilityMetadata {
@ -165,8 +154,6 @@ export const self = CONST_EXPR(new SelfMetadata());
* constructor(public @Parent({self:true}) dependency:Dependency) {}
* }
* ```
*
* @exportedAs angular2/di
*/
@CONST()
export class ParentMetadata extends VisibilityMetadata {
@ -204,8 +191,6 @@ export class ParentMetadata extends VisibilityMetadata {
* constructor(public @Ancestor({self:true}) dependency:Dependency) {}
* }
* ```
*
* @exportedAs angular2/di
*/
@CONST()
export class AncestorMetadata extends VisibilityMetadata {
@ -243,8 +228,6 @@ export class AncestorMetadata extends VisibilityMetadata {
* constructor(public @Ancestor({self:true}) dependency:Dependency) {}
* }
* ```
*
* @exportedAs angular2/di
*/
@CONST()
export class UnboundedMetadata extends VisibilityMetadata {

View File

@ -1,11 +1,5 @@
import {CONST} from 'angular2/src/facade/lang';
/**
*
*
* @exportedAs angular2/di
*/
@CONST()
export class OpaqueToken {
_desc: string;

View File

@ -27,8 +27,6 @@ import {ListWrapper, StringMapWrapper, isListLikeIterable} from 'angular2/src/fa
* Please check errors.
* </div>
* ```
*
* @exportedAs angular2/directives
*/
@Directive({selector: '[class]', lifecycle: [onCheck], properties: ['rawClass: class']})
export class CSSClass {

View File

@ -31,8 +31,6 @@ import {isPresent, isBlank} from 'angular2/src/facade/lang';
* - `<li *ng-for="#item of items; #i = index">...</li>`
* - `<li template="ng-for #item of items; #i = index">...</li>`
* - `<template ng-for #item [ng-for-of]="items" #i="index"><li>...</li></template>`
*
* @exportedAs angular2/directives
*/
@Directive({selector: '[ng-for][ng-for-of]', properties: ['ngForOf'], lifecycle: [onCheck]})
export class NgFor {

View File

@ -23,8 +23,6 @@ import {isBlank} from 'angular2/src/facade/lang';
* - `<div *ng-if="condition">...</div>`
* - `<div template="ng-if condition">...</div>`
* - `<template [ng-if]="condition"><div>...</div></template>`
*
* @exportedAs angular2/directives
*/
@Directive({selector: '[ng-if]', properties: ['ngIf']})
export class NgIf {

View File

@ -12,8 +12,6 @@ import {Directive} from 'angular2/annotations';
* <div>Normal: {{1 + 2}}</div> // output "Normal: 3"
* <div non-bindable>Ignored: {{1 + 2}}</div> // output "Ignored: {{1 + 2}}"
* ```
*
* @exportedAs angular2/directives
*/
@Directive({selector: '[ng-non-bindable]', compileChildren: false})
export class NgNonBindable {

View File

@ -26,8 +26,6 @@ import {Renderer} from 'angular2/src/render/api';
*
* - `<div ng-style="{'text-align': alignEpr}"></div>`
* - `<div ng-style="styleExp"></div>`
*
* @exportedAs angular2/directives
*/
@Directive({selector: '[ng-style]', lifecycle: [onCheck], properties: ['rawStyle: ng-style']})
export class NgStyle {

View File

@ -42,8 +42,6 @@ export class SwitchView {
* <template ng-switch-default>...</template>
* </ANY>
* ```
*
* @exportedAs angular2/directives
*/
@Directive({selector: '[ng-switch]', properties: ['ngSwitch']})
export class NgSwitch {
@ -151,8 +149,6 @@ export class NgSwitch {
* // match against a constant string
* <template ng-switch-when="stringValue">...</template>
* ```
*
* @exportedAs angular2/directives
*/
@Directive({selector: '[ng-switch-when]', properties: ['ngSwitchWhen']})
export class NgSwitchWhen {
@ -187,8 +183,6 @@ export class NgSwitchWhen {
* ```
* <template ng-switch-default>...</template>
* ```
*
* @exportedAs angular2/directives
*/
@Directive({selector: '[ng-switch-default]'})
export class NgSwitchDefault {

View File

@ -31,8 +31,6 @@ export {NgValidator, NgRequiredValidator} from './directives/validators';
* A list of all the form directives used as part of a `@View` annotation.
*
* This is a shorthand for importing them each individually.
*
* @exportedAs angular2/forms
*/
export const formDirectives: List<Type> = CONST_EXPR([
NgControlName,

View File

@ -14,8 +14,6 @@ import {setProperty} from './shared';
* ```
* <input type="checkbox" [ng-control]="rememberLogin">
* ```
*
* @exportedAs angular2/forms
*/
@Directive({
selector:

View File

@ -14,8 +14,6 @@ import {setProperty} from './shared';
* ```
* <input type="text" [(ng-model)]="searchQuery">
* ```
*
* @exportedAs angular2/forms
*/
@Directive({
selector:

View File

@ -5,8 +5,6 @@ import {AbstractControlDirective} from './abstract_control_directive';
* An abstract class that all control directive extend.
*
* It binds a {@link Control} object to a DOM element.
*
* @exportedAs angular2/forms
*/
export class NgControl extends AbstractControlDirective {
name: string = null;

View File

@ -47,8 +47,6 @@ const controlGroupBinding =
* }
*
* ```
*
* @exportedAs angular2/forms
*/
@Directive({
selector: '[ng-control-group]',

View File

@ -70,8 +70,6 @@ const controlNameBinding =
* }
* }
* ```
*
* @exportedAs angular2/forms
*/
@Directive({
selector: '[ng-control]',

View File

@ -44,8 +44,6 @@ const formDirectiveBinding =
* }
*
* ```
*
* @exportedAs angular2/forms
*/
@Directive({
selector: 'form:not([ng-no-form]):not([ng-form-model]),ng-form,[ng-form]',

View File

@ -58,8 +58,6 @@ const formControlBinding =
* }
* }
* ```
*
* @exportedAs angular2/forms
*/
@Directive({
selector: '[ng-form-control]',

View File

@ -79,8 +79,6 @@ const formDirectiveBinding =
* }
* }
* ```
*
* @exportedAs angular2/forms
*/
@Directive({
selector: '[ng-form-model]',

View File

@ -28,8 +28,6 @@ const formControlBinding = CONST_EXPR(new Binding(NgControl, {toAlias: forwardRe
* searchQuery: string;
* }
* ```
*
* @exportedAs angular2/forms
*/
@Directive({
selector: '[ng-model]:not([ng-control]):not([ng-form-control])',

View File

@ -16,7 +16,6 @@ import {setProperty} from './shared';
* <option *ng-for="#c of cities" [value]="c"></option>
* </select>
* ``
* @exportedAs angular2/forms
*/
@Directive({selector: 'option'})
export class NgSelectOption {
@ -24,8 +23,6 @@ export class NgSelectOption {
/**
* The accessor for writing a value and listening to changes on a select element.
*
* @exportedAs angular2/forms
*/
@Directive({
selector: 'select[ng-control],select[ng-form-control],select[ng-model]',

View File

@ -66,7 +66,6 @@ import * as modelModule from './model';
* });
*
* ```
* @exportedAs angular2/forms
*/
export class FormBuilder {
group(controlsConfig: StringMap<string, any>,

View File

@ -5,15 +5,11 @@ import {Validators} from './validators';
/**
* Indicates that a Control is valid, i.e. that no errors exist in the input value.
*
* @exportedAs angular2/forms
*/
export const VALID = "VALID";
/**
* Indicates that a Control is invalid, i.e. that an error exists in the input value.
*
* @exportedAs angular2/forms
*/
export const INVALID = "INVALID";
@ -144,8 +140,6 @@ export class AbstractControl {
* `Control` is one of the three fundamental building blocks used to define forms in Angular, along
* with
* {@link ControlGroup} and {@link ControlArray}.
*
* @exportedAs angular2/forms
*/
export class Control extends AbstractControl {
_onChange: Function;
@ -181,8 +175,6 @@ export class Control extends AbstractControl {
* {@link Control} and {@link ControlArray}. {@link ControlArray} can also contain other controls,
* but is of variable
* length.
*
* @exportedAs angular2/forms
*/
export class ControlGroup extends AbstractControl {
controls: StringMap<string, AbstractControl>;
@ -263,12 +255,8 @@ export class ControlGroup extends AbstractControl {
* changes as well.
*
* `ControlArray` is one of the three fundamental building blocks used to define forms in Angular,
* along with
* {@link Control} and {@link ControlGroup}. {@link ControlGroup} can also contain other controls,
* but is of fixed
* length.
*
* @exportedAs angular2/forms
* along with {@link Control} and {@link ControlGroup}. {@link ControlGroup} can also contain
* other controls, but is of fixed length.
*/
export class ControlArray extends AbstractControl {
controls: List<AbstractControl>;

View File

@ -11,8 +11,6 @@ import * as modelModule from './model';
* ```
* var loginControl = new Control("", Validators.required)
* ```
*
* @exportedAs angular2/forms
*/
export class Validators {
static required(c: modelModule.Control): StringMap<string, boolean> {

View File

@ -35,8 +35,6 @@ let _resolveToFalse = PromiseWrapper.resolve(false);
* When the router navigates from a URL, it must first recognizes it and serialize it into an
* `Instruction`.
* The router uses the `RouteRegistry` to get an `Instruction`.
*
* @exportedAs angular2/router
*/
export class Router {
navigating: boolean = false;

View File

@ -32,8 +32,6 @@ import {Location} from './location';
* If the route begins with `./`, the router will instead look in the current component's
* children for the route. And if the route begins with `../`, the router will look at the
* current component's parent.
*
* @exportedAs angular2/router
*/
@Directive({
selector: '[router-link]',

View File

@ -21,9 +21,6 @@ import {DOM} from 'angular2/src/dom/dom_adapter';
import {DebugElement} from 'angular2/src/debug/debug_element';
/**
* @exportedAs angular2/test
*/
export class RootTestComponent extends DebugElement {
_componentRef: ComponentRef;
_componentParentView: AppView;
@ -46,8 +43,6 @@ export class RootTestComponent extends DebugElement {
var _nextRootElementId = 0;
/**
* @exportedAs angular2/test
*
* Builds a RootTestComponent for use in component level tests.
*/
@Injectable()

View File

@ -163,7 +163,6 @@ export function createTestInjector(bindings: List<Type | Binding | List<any>>):
* @param {Array} tokens
* @param {Function} fn
* @return {FunctionWithParamTokens}
* @exportedAs angular2/test
*/
export function inject(tokens: List<any>, fn: Function): FunctionWithParamTokens {
return new FunctionWithParamTokens(tokens, fn);

View File

@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* This module is used for writing tests for applications written in Angular.
*

View File

@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* Provides API for working with Angular views.
*/