cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(test_lib/test_injector): fix invalid jsdoc type

Browse Source 
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:
Peter Bacon Darwin
2015-04-10 12:45:02 +02:00
committed by Misko Hevery
parent 82127571b5
commit b5002fb46b
47 changed files with 228 additions and 149 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
modules/angular2/src/change_detection/binding_propagation_config.js vendored
View File

@ -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;

4
modules/angular2/src/change_detection/pipes/iterable_changes.js vendored
View File

@ -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;

6
modules/angular2/src/change_detection/pipes/keyvalue_changes.js vendored
View File

@ -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;

4
modules/angular2/src/change_detection/pipes/null_pipe.js vendored
View File

@ -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;

2
modules/angular2/src/change_detection/pipes/pipe.js vendored
View File

@ -1,7 +1,7 @@
export var NO_CHANGE = new Object();
/**
* @publicModule angular2/angular2
* @exportedAs angular2/angular2
*/
export class Pipe {
supports(obj):boolean {return false;}