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:
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

View File

@ -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]',

View File

@ -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]',

View File

@ -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]',

View File

@ -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]'