docs(test_lib/test_injector): fix invalid jsdoc type
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
This commit is contained in:

committed by
Misko Hevery

parent
82127571b5
commit
b5002fb46b
@ -232,7 +232,7 @@ import {Injectable} from 'angular2/di';
|
||||
* This directive would be instantiated with a `Dependency` directive found on the current element. If none can be
|
||||
* found, the injector supplies `null` instead of throwing an error.
|
||||
*
|
||||
* @publicModule angular2/annotations
|
||||
* @exportedAs angular2/annotations
|
||||
*/
|
||||
@ABSTRACT()
|
||||
export class Directive extends Injectable {
|
||||
@ -478,7 +478,7 @@ export class Directive extends Injectable {
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* @publicModule angular2/annotations
|
||||
* @exportedAs angular2/annotations
|
||||
*/
|
||||
export class Component extends Directive {
|
||||
/**
|
||||
@ -614,7 +614,7 @@ export class Component extends Directive {
|
||||
*
|
||||
*
|
||||
*
|
||||
* @publicModule angular2/annotations
|
||||
* @exportedAs angular2/annotations
|
||||
*/
|
||||
export class DynamicComponent extends Directive {
|
||||
/**
|
||||
@ -706,7 +706,7 @@ export class DynamicComponent extends Directive {
|
||||
* <div tooltip="some text here"></div>
|
||||
* ```
|
||||
*
|
||||
* @publicModule angular2/annotations
|
||||
* @exportedAs angular2/annotations
|
||||
*/
|
||||
export class Decorator extends Directive {
|
||||
|
||||
@ -832,7 +832,7 @@ export class Decorator extends Directive {
|
||||
* view occurs on the second `<li></li>` which is a sibling to the `<template>` element.
|
||||
*
|
||||
*
|
||||
* @publicModule angular2/annotations
|
||||
* @exportedAs angular2/annotations
|
||||
*/
|
||||
export class Viewport extends Directive {
|
||||
@CONST()
|
||||
@ -874,7 +874,7 @@ export class Viewport extends Directive {
|
||||
* }
|
||||
* }
|
||||
* ```
|
||||
* @publicModule angular2/annotations
|
||||
* @exportedAs angular2/annotations
|
||||
*/
|
||||
export const onDestroy = "onDestroy";
|
||||
|
||||
@ -912,7 +912,7 @@ export const onDestroy = "onDestroy";
|
||||
* }
|
||||
* }
|
||||
* ```
|
||||
* @publicModule angular2/annotations
|
||||
* @exportedAs angular2/annotations
|
||||
*/
|
||||
export const onChange = "onChange";
|
||||
|
||||
@ -933,6 +933,6 @@ export const onChange = "onChange";
|
||||
*
|
||||
* }
|
||||
* ```
|
||||
* @publicModule angular2/annotations
|
||||
* @exportedAs angular2/annotations
|
||||
*/
|
||||
export const onAllChangesDone = "onAllChangesDone";
|
||||
|
@ -29,7 +29,7 @@ import {ABSTRACT, CONST, Type} from 'angular2/src/facade/lang';
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* @publicModule angular2/annotations
|
||||
* @exportedAs angular2/annotations
|
||||
*/
|
||||
export class View {
|
||||
templateUrl:any; //string;
|
||||
|
@ -40,7 +40,7 @@ import {DependencyAnnotation} from 'angular2/di';
|
||||
* 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`.
|
||||
*
|
||||
* @publicModule angular2/annotations
|
||||
* @exportedAs angular2/annotations
|
||||
*/
|
||||
export class Parent extends DependencyAnnotation {
|
||||
@CONST()
|
||||
@ -101,7 +101,7 @@ export class Parent extends DependencyAnnotation {
|
||||
*
|
||||
* Angular injects `dependency=2`.
|
||||
*
|
||||
* @publicModule angular2/annotations
|
||||
* @exportedAs angular2/annotations
|
||||
*/
|
||||
export class Ancestor extends DependencyAnnotation {
|
||||
@CONST()
|
||||
|
Reference in New Issue
Block a user