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
10
modules/angular2/src/forms/directives.js
vendored
10
modules/angular2/src/forms/directives.js
vendored
@ -11,7 +11,7 @@ import {Validators} from './validators';
|
||||
//}
|
||||
|
||||
/**
|
||||
* @publicModule angular2/forms
|
||||
* @exportedAs angular2/forms
|
||||
*/
|
||||
@Decorator({
|
||||
selector: '[control]',
|
||||
@ -35,7 +35,7 @@ export class DefaultValueAccessor {
|
||||
}
|
||||
|
||||
/**
|
||||
* @publicModule angular2/forms
|
||||
* @exportedAs angular2/forms
|
||||
*/
|
||||
@Decorator({
|
||||
selector: 'input[type=checkbox][control]',
|
||||
@ -59,7 +59,7 @@ export class CheckboxControlValueAccessor {
|
||||
}
|
||||
|
||||
/**
|
||||
* @publicModule angular2/forms
|
||||
* @exportedAs angular2/forms
|
||||
*/
|
||||
@Decorator({
|
||||
lifecycle: [onChange],
|
||||
@ -119,7 +119,7 @@ export class ControlDirective {
|
||||
}
|
||||
|
||||
/**
|
||||
* @publicModule angular2/forms
|
||||
* @exportedAs angular2/forms
|
||||
*/
|
||||
@Decorator({
|
||||
selector: '[control-group]',
|
||||
@ -170,7 +170,7 @@ export class ControlGroupDirective {
|
||||
}
|
||||
|
||||
/**
|
||||
* @publicModule angular2/forms
|
||||
* @exportedAs angular2/forms
|
||||
*/
|
||||
// todo(misko): rename to lover case as it is not a Type but a var.
|
||||
export var FormDirectives = [
|
||||
|
2
modules/angular2/src/forms/form_builder.js
vendored
2
modules/angular2/src/forms/form_builder.js
vendored
@ -4,7 +4,7 @@ import * as modelModule from './model';
|
||||
|
||||
|
||||
/**
|
||||
* @publicModule angular2/forms
|
||||
* @exportedAs angular2/forms
|
||||
*/
|
||||
export class FormBuilder {
|
||||
group(controlsConfig, extra = null):modelModule.ControlGroup {
|
||||
|
12
modules/angular2/src/forms/model.js
vendored
12
modules/angular2/src/forms/model.js
vendored
@ -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;
|
||||
|
2
modules/angular2/src/forms/validators.js
vendored
2
modules/angular2/src/forms/validators.js
vendored
@ -4,7 +4,7 @@ import {List, ListWrapper, StringMapWrapper} from 'angular2/src/facade/collectio
|
||||
import * as modelModule from './model';
|
||||
|
||||
/**
|
||||
* @publicModule angular2/forms
|
||||
* @exportedAs angular2/forms
|
||||
*/
|
||||
export class Validators {
|
||||
static required(c:modelModule.Control) {
|
||||
|
Reference in New Issue
Block a user