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
@ -2,7 +2,7 @@ import {ChangeDetector} from './interfaces';
|
||||
import {CHECK_ONCE, DETACHED, CHECK_ALWAYS} from './constants';
|
||||
|
||||
/**
|
||||
* @publicModule angular2/change_detection
|
||||
* @exportedAs angular2/change_detection
|
||||
*/
|
||||
export class BindingPropagationConfig {
|
||||
_cd:ChangeDetector;
|
||||
|
@ -27,7 +27,7 @@ export class IterableChangesFactory {
|
||||
}
|
||||
|
||||
/**
|
||||
* @publicModule angular2/pipes
|
||||
* @exportedAs angular2/pipes
|
||||
*/
|
||||
export class IterableChanges extends Pipe {
|
||||
_collection;
|
||||
@ -505,7 +505,7 @@ export class IterableChanges extends Pipe {
|
||||
}
|
||||
|
||||
/**
|
||||
* @publicModule angular2/pipes
|
||||
* @exportedAs angular2/pipes
|
||||
*/
|
||||
export class CollectionChangeRecord {
|
||||
currentIndex:int;
|
||||
|
@ -4,7 +4,7 @@ import {stringify, looseIdentical, isJsObject} from 'angular2/src/facade/lang';
|
||||
import {NO_CHANGE, Pipe} from './pipe';
|
||||
|
||||
/**
|
||||
* @publicModule angular2/pipes
|
||||
* @exportedAs angular2/pipes
|
||||
*/
|
||||
export class KeyValueChangesFactory {
|
||||
supports(obj):boolean {
|
||||
@ -17,7 +17,7 @@ export class KeyValueChangesFactory {
|
||||
}
|
||||
|
||||
/**
|
||||
* @publicModule angular2/pipes
|
||||
* @exportedAs angular2/pipes
|
||||
*/
|
||||
export class KeyValueChanges extends Pipe {
|
||||
_records:Map;
|
||||
@ -356,7 +356,7 @@ export class KeyValueChanges extends Pipe {
|
||||
|
||||
|
||||
/**
|
||||
* @publicModule angular2/pipes
|
||||
* @exportedAs angular2/pipes
|
||||
*/
|
||||
export class KVChangeRecord {
|
||||
key;
|
||||
|
@ -2,7 +2,7 @@ import {isBlank} from 'angular2/src/facade/lang';
|
||||
import {Pipe, NO_CHANGE} from './pipe';
|
||||
|
||||
/**
|
||||
* @publicModule angular2/pipes
|
||||
* @exportedAs angular2/pipes
|
||||
*/
|
||||
export class NullPipeFactory {
|
||||
supports(obj):boolean {
|
||||
@ -15,7 +15,7 @@ export class NullPipeFactory {
|
||||
}
|
||||
|
||||
/**
|
||||
* @publicModule angular2/pipes
|
||||
* @exportedAs angular2/pipes
|
||||
*/
|
||||
export class NullPipe extends Pipe {
|
||||
called:boolean;
|
||||
|
@ -1,7 +1,7 @@
|
||||
export var NO_CHANGE = new Object();
|
||||
|
||||
/**
|
||||
* @publicModule angular2/angular2
|
||||
* @exportedAs angular2/angular2
|
||||
*/
|
||||
export class Pipe {
|
||||
supports(obj):boolean {return false;}
|
||||
|
@ -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()
|
||||
|
2
modules/angular2/src/core/application.js
vendored
2
modules/angular2/src/core/application.js
vendored
@ -240,7 +240,7 @@ function _createVmZone(givenReporter:Function): VmTurnZone {
|
||||
*
|
||||
* Returns a [Promise] with the application`s private [Injector].
|
||||
*
|
||||
* @publicModule angular2/angular2
|
||||
* @exportedAs angular2/angular2
|
||||
*/
|
||||
export function bootstrap(appComponentType: Type,
|
||||
componentInjectableBindings: List<Binding> = null,
|
||||
|
@ -1,5 +1,5 @@
|
||||
/**
|
||||
* @publicModule angular2/angular2
|
||||
* @exportedAs angular2/angular2
|
||||
*/
|
||||
export class OnChange {
|
||||
onChange(changes) {
|
||||
|
@ -9,7 +9,7 @@ import {DirectDomViewRef} from 'angular2/src/render/dom/direct_dom_renderer';
|
||||
* Attention: NgElement will be replaced by a different concept
|
||||
* for accessing an element in a way that is compatible with the render layer.
|
||||
*
|
||||
* @publicModule angular2/angular2
|
||||
* @exportedAs angular2/angular2
|
||||
*/
|
||||
export class NgElement {
|
||||
_view:viewModule.AppView;
|
||||
|
4
modules/angular2/src/core/compiler/view.js
vendored
4
modules/angular2/src/core/compiler/view.js
vendored
@ -13,7 +13,7 @@ import * as renderApi from 'angular2/src/render/api';
|
||||
/**
|
||||
* Const of making objects: http://jsperf.com/instantiate-size-of-object
|
||||
*
|
||||
* @publicModule angular2/template
|
||||
* @exportedAs angular2/template
|
||||
*/
|
||||
@IMPLEMENTS(ChangeDispatcher)
|
||||
// TODO(tbosch): this is not supported in dart2js (no '.' is allowed)
|
||||
@ -288,7 +288,7 @@ export class AppView {
|
||||
|
||||
/**
|
||||
*
|
||||
* @publicModule angular2/template
|
||||
* @exportedAs angular2/template
|
||||
*/
|
||||
export class AppProtoView {
|
||||
elementBinders:List<ElementBinder>;
|
||||
|
@ -9,7 +9,7 @@ import * as viewModule from './view';
|
||||
import * as vfModule from './view_factory';
|
||||
|
||||
/**
|
||||
* @publicModule angular2/template
|
||||
* @exportedAs angular2/template
|
||||
*/
|
||||
export class ViewContainer {
|
||||
render:renderApi.ViewContainerRef;
|
||||
|
@ -3,7 +3,7 @@ import {isPresent, print} from 'angular2/src/facade/lang';
|
||||
import {ListWrapper, isListLikeIterable} from 'angular2/src/facade/collection';
|
||||
|
||||
/**
|
||||
* @publicModule angular2/angular2
|
||||
* @exportedAs angular2/angular2
|
||||
*/
|
||||
@Injectable()
|
||||
export class ExceptionHandler {
|
||||
|
@ -5,7 +5,7 @@ import {ExceptionHandler} from 'angular2/src/core/exception_handler';
|
||||
import {isPresent} from 'angular2/src/facade/lang';
|
||||
|
||||
/**
|
||||
* @publicModule angular2/change_detection
|
||||
* @exportedAs angular2/change_detection
|
||||
*/
|
||||
@Injectable()
|
||||
export class LifeCycle {
|
||||
|
2
modules/angular2/src/directives/for.js
vendored
2
modules/angular2/src/directives/for.js
vendored
@ -34,7 +34,7 @@ import {ListWrapper} from 'angular2/src/facade/collection';
|
||||
* - `<li template="for #item of items; #i=index">...</li>`
|
||||
* - `<template [for]="#item" [of]="items" #i="index"><li>...</li></template>`
|
||||
*
|
||||
* @publicModule angular2/directives
|
||||
* @exportedAs angular2/directives
|
||||
*/
|
||||
@Viewport({
|
||||
selector: '[for][of]',
|
||||
|
2
modules/angular2/src/directives/if.js
vendored
2
modules/angular2/src/directives/if.js
vendored
@ -22,7 +22,7 @@ import {isBlank} from 'angular2/src/facade/lang';
|
||||
* - `<div template="if condition">...</div>`
|
||||
* - `<template [if]="condition"><div>...</div></template>`
|
||||
*
|
||||
* @publicModule angular2/directives
|
||||
* @exportedAs angular2/directives
|
||||
*/
|
||||
@Viewport({
|
||||
selector: '[if]',
|
||||
|
@ -13,7 +13,7 @@ import {Decorator} from 'angular2/src/core/annotations/annotations';
|
||||
* <div non-bindable>Ignored: {{1 + 2}}</div> // output "Ignored: {{1 + 2}}"
|
||||
* ```
|
||||
*
|
||||
* @publicModule angular2/directives
|
||||
* @exportedAs angular2/directives
|
||||
*/
|
||||
@Decorator({
|
||||
selector: '[non-bindable]',
|
||||
|
8
modules/angular2/src/directives/switch.js
vendored
8
modules/angular2/src/directives/switch.js
vendored
@ -29,7 +29,7 @@ import {Parent} from 'angular2/src/core/annotations/visibility';
|
||||
* </ANY>
|
||||
* ```
|
||||
*
|
||||
* @publicModule angular2/directives
|
||||
* @exportedAs angular2/directives
|
||||
*/
|
||||
@Decorator({
|
||||
selector: '[switch]',
|
||||
@ -142,7 +142,7 @@ export class Switch {
|
||||
* <template [switch-when]="'stringValue'">...</template>
|
||||
* ```
|
||||
*
|
||||
* @publicModule angular2/directives
|
||||
* @exportedAs angular2/directives
|
||||
*/
|
||||
@Viewport({
|
||||
selector: '[switch-when]',
|
||||
@ -179,10 +179,10 @@ export class SwitchWhen {
|
||||
* ```
|
||||
* <template [switch-default]>...</template>
|
||||
*
|
||||
* @publicModule angular2/directives
|
||||
* @exportedAs angular2/directives
|
||||
* ```
|
||||
*
|
||||
* @publicModule angular2/directives
|
||||
* @exportedAs angular2/directives
|
||||
*/
|
||||
@Viewport({
|
||||
selector: '[switch-default]'
|
||||
|
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) {
|
||||
|
@ -11,7 +11,7 @@ import {UrlResolver} from 'angular2/src/services/url_resolver';
|
||||
|
||||
/**
|
||||
* Strategy to load component templates.
|
||||
* @publicModule angular2/angular2
|
||||
* @exportedAs angular2/angular2
|
||||
*/
|
||||
@Injectable()
|
||||
export class TemplateLoader {
|
||||
|
@ -46,7 +46,7 @@ import * as rvf from 'angular2/src/render/dom/view/view_factory';
|
||||
*
|
||||
* This must be kept in sync with the _rootBindings in application.js
|
||||
*
|
||||
* @returns {*[]}
|
||||
* @returns {any[]}
|
||||
*/
|
||||
function _getRootBindings() {
|
||||
return [
|
||||
@ -59,7 +59,7 @@ function _getRootBindings() {
|
||||
*
|
||||
* This must be kept in sync with _injectorBindings() in application.js
|
||||
*
|
||||
* @returns {*[]}
|
||||
* @returns {any[]}
|
||||
*/
|
||||
function _getAppBindings() {
|
||||
var appDoc;
|
||||
|
Reference in New Issue
Block a user