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
Vendored
+6
-6
@@ -4,12 +4,12 @@ import {StringMap, StringMapWrapper, ListWrapper, List} from 'angular2/src/facad
|
||||
import {Validators} from './validators';
|
||||
|
||||
/**
|
||||
* @publicModule angular2/forms
|
||||
* @exportedAs angular2/forms
|
||||
*/
|
||||
export const VALID = "VALID";
|
||||
|
||||
/**
|
||||
* @publicModule angular2/forms
|
||||
* @exportedAs angular2/forms
|
||||
*/
|
||||
export const INVALID = "INVALID";
|
||||
|
||||
@@ -26,7 +26,7 @@ export const INVALID = "INVALID";
|
||||
//}
|
||||
|
||||
/**
|
||||
* @publicModule angular2/forms
|
||||
* @exportedAs angular2/forms
|
||||
*/
|
||||
export class AbstractControl {
|
||||
_value:any;
|
||||
@@ -80,7 +80,7 @@ export class AbstractControl {
|
||||
}
|
||||
|
||||
/**
|
||||
* @publicModule angular2/forms
|
||||
* @exportedAs angular2/forms
|
||||
*/
|
||||
export class Control extends AbstractControl {
|
||||
constructor(value:any, validator:Function = Validators.nullValidator) {
|
||||
@@ -108,7 +108,7 @@ export class Control extends AbstractControl {
|
||||
}
|
||||
|
||||
/**
|
||||
* @publicModule angular2/forms
|
||||
* @exportedAs angular2/forms
|
||||
*/
|
||||
export class ControlGroup extends AbstractControl {
|
||||
controls:StringMap;
|
||||
@@ -186,7 +186,7 @@ export class ControlGroup extends AbstractControl {
|
||||
}
|
||||
|
||||
/**
|
||||
* @publicModule angular2/forms
|
||||
* @exportedAs angular2/forms
|
||||
*/
|
||||
export class ControlArray extends AbstractControl {
|
||||
controls:List;
|
||||
|
||||
Reference in New Issue
Block a user