b5002fb46b
chore(doc-gen): capture docs for modules from comments Closes #1258 docs(*): add module description jsdoc tags docs(*): add @public tag to public modules chore(doc-gen): fix overview-dump template The template was referencing an invalid property chore(doc-gen): use `@exportedAs` and `@public` rather than `@publicModule` This commit refactors how we describe components that are re-exported in another module. For example the "public" modules like `angular/angular` and `angular/annotations` are public but they only re-export components from "private" modules. Previously, you must apply the `@publicModule` tag to a component that was to be re-exported. Applying this tag caused the destination module to become public. Now, you specify that a module is public by applying the `@public` tag and then you can "re-export" components to other modules by applying the `@exportedAs` giving the name of the module from which the component will be re-exported. tag. This tag can be used multiple times on a single component, allowing the component to be exported on multiple modules. docs(*): rename `@publicModule` to `@exportedAs` The `@publicModule` dgeni tag has been replaced by the `@exportedAs` dgeni tag on components that are to be re-exported on another module. Closes #1290
90 lines
3.1 KiB
JavaScript
90 lines
3.1 KiB
JavaScript
/**
|
|
* @module
|
|
* @public
|
|
* @description
|
|
* Description of the change_detection module
|
|
*/
|
|
|
|
export {
|
|
ASTWithSource, AST, AstTransformer, AccessMember, LiteralArray, ImplicitReceiver
|
|
} from './src/change_detection/parser/ast';
|
|
export {Lexer} from './src/change_detection/parser/lexer';
|
|
export {Parser} from './src/change_detection/parser/parser';
|
|
export {Locals}
|
|
from './src/change_detection/parser/locals';
|
|
export {ExpressionChangedAfterItHasBeenChecked, ChangeDetectionError}
|
|
from './src/change_detection/exceptions';
|
|
export {ProtoChangeDetector, ChangeDispatcher, ChangeDetector, ChangeDetection} from './src/change_detection/interfaces';
|
|
export {CHECK_ONCE, CHECK_ALWAYS, DETACHED, CHECKED, ON_PUSH, DEFAULT} from './src/change_detection/constants';
|
|
export {DynamicProtoChangeDetector, JitProtoChangeDetector}
|
|
from './src/change_detection/proto_change_detector';
|
|
export {BindingRecord}
|
|
from './src/change_detection/binding_record';
|
|
export {DirectiveRecord}
|
|
from './src/change_detection/directive_record';
|
|
export {DynamicChangeDetector}
|
|
from './src/change_detection/dynamic_change_detector';
|
|
export {BindingPropagationConfig}
|
|
from './src/change_detection/binding_propagation_config';
|
|
export * from './src/change_detection/pipes/pipe_registry';
|
|
export {uninitialized} from './src/change_detection/change_detection_util';
|
|
export * from './src/change_detection/pipes/pipe';
|
|
|
|
import {DynamicProtoChangeDetector, JitProtoChangeDetector}
|
|
from './src/change_detection/proto_change_detector';
|
|
import {PipeRegistry} from './src/change_detection/pipes/pipe_registry';
|
|
import {IterableChangesFactory} from './src/change_detection/pipes/iterable_changes';
|
|
import {KeyValueChangesFactory} from './src/change_detection/pipes/keyvalue_changes';
|
|
import {NullPipeFactory} from './src/change_detection/pipes/null_pipe';
|
|
import {DEFAULT} from './src/change_detection/constants';
|
|
import {ChangeDetection, ProtoChangeDetector} from './src/change_detection/interfaces';
|
|
|
|
export var defaultPipes = {
|
|
"iterableDiff" : [
|
|
new IterableChangesFactory(),
|
|
new NullPipeFactory()
|
|
],
|
|
"keyValDiff" : [
|
|
new KeyValueChangesFactory(),
|
|
new NullPipeFactory()
|
|
]
|
|
};
|
|
|
|
|
|
/**
|
|
* @exportedAs angular2/change_detection
|
|
*/
|
|
export class DynamicChangeDetection extends ChangeDetection {
|
|
registry:PipeRegistry;
|
|
|
|
constructor(registry:PipeRegistry) {
|
|
super();
|
|
this.registry = registry;
|
|
}
|
|
|
|
createProtoChangeDetector(name:string, changeControlStrategy:string = DEFAULT):ProtoChangeDetector{
|
|
return new DynamicProtoChangeDetector(this.registry, changeControlStrategy);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @exportedAs angular2/change_detection
|
|
*/
|
|
export class JitChangeDetection extends ChangeDetection {
|
|
registry:PipeRegistry;
|
|
|
|
constructor(registry:PipeRegistry) {
|
|
super();
|
|
this.registry = registry;
|
|
}
|
|
|
|
createProtoChangeDetector(name:string, changeControlStrategy:string = DEFAULT):ProtoChangeDetector{
|
|
return new JitProtoChangeDetector(this.registry, changeControlStrategy);
|
|
}
|
|
}
|
|
|
|
var _registry = new PipeRegistry(defaultPipes);
|
|
|
|
export var dynamicChangeDetection = new DynamicChangeDetection(_registry);
|
|
export var jitChangeDetection = new JitChangeDetection(_registry);
|