docs: create public API surface

Closes #1181
This commit is contained in:
Misko Hevery
2015-03-31 22:47:11 +00:00
parent c1aa65239e
commit 86dc3e5b07
23 changed files with 115 additions and 10 deletions

View File

@ -22,7 +22,6 @@ import {CssProcessor} from './css_processor';
/**
* Cache that stores the ProtoView of the template of a component.
* Used to prevent duplicate work and resolve cyclic dependencies.
* @publicModule angular2/angular2
*/
@Injectable()
export class CompilerCache {
@ -49,7 +48,8 @@ export class CompilerCache {
* The compiler loads and translates the html templates of components into
* nested ProtoViews. To decompose its functionality it uses
* the CompilePipeline and the CompileSteps.
* @publicModule angular2/angular2
*
* @publicModule angular2/template
*/
@Injectable()
export class Compiler {
@ -90,6 +90,7 @@ export class Compiler {
this._cssProcessor = cssProcessor;
}
// todo(misko): should be private method
createSteps(component:Type, template: Template):List<CompileStep> {
var dirMetadata = ListWrapper.map(this._flattenDirectives(template),
(d) => this._reader.read(d));

View File

@ -30,6 +30,9 @@ function _emptyStep() {
return _EMPTY_STEP;
}
/**
* @publicModule angular2/template
*/
export class ShadowDomStrategy {
attachTemplate(el, view:viewModule.View) {}
constructLightDom(lightDomView:viewModule.View, shadowDomView:viewModule.View, el): LightDom { return null; }
@ -77,6 +80,8 @@ export class ShadowDomStrategy {
* Notes:
* - styles are **not** scoped to their component and will apply to the whole document,
* - you can **not** use shadow DOM specific selectors in the styles
*
* @publicModule angular2/template
*/
@Injectable()
export class EmulatedUnscopedShadowDomStrategy extends ShadowDomStrategy {
@ -119,6 +124,8 @@ export class EmulatedUnscopedShadowDomStrategy extends ShadowDomStrategy {
* - styles are scoped to their component and will apply only to it,
* - a common subset of shadow DOM selectors are supported,
* - see `ShadowCss` for more information and limitations.
*
* @publicModule angular2/template
*/
@Injectable()
export class EmulatedScopedShadowDomStrategy extends EmulatedUnscopedShadowDomStrategy {

View File

@ -11,7 +11,7 @@ import {UrlResolver} from 'angular2/src/services/url_resolver';
/**
* Strategy to load component templates.
* @publicModule angular2/angular2
* @publicModule angular2/template
*/
@Injectable()
export class TemplateLoader {

View File

@ -27,7 +27,8 @@ var VIEW_POOL_PREFILL = 0;
/**
* Const of making objects: http://jsperf.com/instantiate-size-of-object
* @publicModule angular2/angular2
*
* @publicModule angular2/template
*/
@IMPLEMENTS(ChangeDispatcher)
export class View {
@ -284,7 +285,8 @@ export class View {
}
/**
* @publicModule angular2/angular2
*
* @publicModule angular2/template
*/
export class ProtoView {
element;
@ -692,7 +694,6 @@ export class ProtoView {
}
/**
* @publicModule angular2/angular2
*/
export class ElementBindingMemento {
_elementIndex:int;
@ -711,7 +712,6 @@ export class ElementBindingMemento {
}
/**
* @publicModule angular2/angular2
*/
export class DirectiveBindingMemento {
_elementInjectorIndex:int;
@ -757,7 +757,6 @@ class DirectiveMemento {
}
/**
* @publicModule angular2/angular2
*/
export class PropertyUpdate {
currentValue;

View File

@ -9,7 +9,7 @@ import {EventManager} from 'angular2/src/render/dom/events/event_manager';
import {LightDom} from './shadow_dom_emulation/light_dom';
/**
* @publicModule angular2/angular2
* @publicModule angular2/template
*/
export class ViewContainer {
parentView: viewModule.View;

View File

@ -2,6 +2,9 @@ import {Injectable} from 'angular2/di';
import {isPresent, print} from 'angular2/src/facade/lang';
import {ListWrapper, isListLikeIterable} from 'angular2/src/facade/collection';
/**
* @publicModule angular2/angular2
*/
@Injectable()
export class ExceptionHandler {
call(error, stackTrace = null, reason = null) {

View File

@ -4,6 +4,9 @@ import {VmTurnZone} from 'angular2/src/core/zone/vm_turn_zone';
import {ExceptionHandler} from 'angular2/src/core/exception_handler';
import {isPresent} from 'angular2/src/facade/lang';
/**
* @publicModule angular2/change_detection
*/
@Injectable()
export class LifeCycle {
_errorHandler;