Peter Bacon Darwin
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
112 lines
2.5 KiB
JavaScript
112 lines
2.5 KiB
JavaScript
import {CONST} from 'angular2/src/facade/lang';
|
|
import {DependencyAnnotation} from 'angular2/di';
|
|
|
|
/**
|
|
* Specifies that an injector should retrieve a dependency from the direct parent.
|
|
*
|
|
* ## Example
|
|
*
|
|
* Here is a simple directive that retrieves a dependency from its parent element.
|
|
*
|
|
* ```
|
|
* @Decorator({
|
|
* selector: '[dependency]',
|
|
* properties: {
|
|
* 'id':'dependency'
|
|
* }
|
|
* })
|
|
* class Dependency {
|
|
* id:string;
|
|
* }
|
|
*
|
|
*
|
|
* @Decorator({
|
|
* selector: '[my-directive]'
|
|
* })
|
|
* class Dependency {
|
|
* constructor(@Parent() dependency:Dependency) {
|
|
* expect(dependency.id).toEqual(1);
|
|
* };
|
|
* }
|
|
* ```
|
|
*
|
|
* We use this with the following HTML template:
|
|
*
|
|
* ```
|
|
* <div dependency="1">
|
|
* <div dependency="2" my-directive></div>
|
|
* </div>
|
|
* ```
|
|
* The `@Parent()` annotation in our constructor forces the injector to retrieve the dependency from the
|
|
* parent element (even thought the current element could resolve it): Angular injects `dependency=1`.
|
|
*
|
|
* @exportedAs angular2/annotations
|
|
*/
|
|
export class Parent extends DependencyAnnotation {
|
|
@CONST()
|
|
constructor() {
|
|
super();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Specifies that an injector should retrieve a dependency from any ancestor element.
|
|
*
|
|
* An ancestor is any element between the parent element and shadow root.
|
|
*
|
|
*
|
|
* ## Example
|
|
*
|
|
* Here is a simple directive that retrieves a dependency from an ancestor element.
|
|
*
|
|
* ```
|
|
* @Decorator({
|
|
* selector: '[dependency]',
|
|
* properties: {
|
|
* 'id':'dependency'
|
|
* }
|
|
* })
|
|
* class Dependency {
|
|
* id:string;
|
|
* }
|
|
*
|
|
*
|
|
* @Decorator({
|
|
* selector: '[my-directive]'
|
|
* })
|
|
* class Dependency {
|
|
* constructor(@Ancestor() dependency:Dependency) {
|
|
* expect(dependency.id).toEqual(2);
|
|
* };
|
|
* }
|
|
* ```
|
|
*
|
|
* We use this with the following HTML template:
|
|
*
|
|
* ```
|
|
* <div dependency="1">
|
|
* <div dependency="2">
|
|
* <div>
|
|
* <div dependency="3" my-directive></div>
|
|
* </div>
|
|
* </div>
|
|
* </div>
|
|
* ```
|
|
*
|
|
* The `@Ancestor()` annotation in our constructor forces the injector to retrieve the dependency from the
|
|
* nearest ancestor element:
|
|
* - The current element `dependency="3"` is skipped because it is not an ancestor.
|
|
* - Next parent has no directives `<div>`
|
|
* - Next parent has the `Dependency` directive and so the dependency is satisfied.
|
|
*
|
|
* Angular injects `dependency=2`.
|
|
*
|
|
* @exportedAs angular2/annotations
|
|
*/
|
|
export class Ancestor extends DependencyAnnotation {
|
|
@CONST()
|
|
constructor() {
|
|
super();
|
|
}
|
|
}
|