@angular/core 6.0.3 → 6.0.7

package/src/event_emitter.d.ts

@@ -9,6 +9,7 @@ import { Subject } from 'rxjs';
 /**
  * Use by directives and components to emit custom Events.
  *
+ * @usageNotes
  * ### Examples
  *
  * In the following example, `Zippy` alternatively emits `open` and `close` events when its
@@ -47,6 +48,8 @@ import { Subject } from 'rxjs';
  * <zippy (open)="onOpen($event)" (close)="onClose($event)"></zippy>
  * ```
  *
+ * ### Notes
+ *
  * Uses Rx.Observable but provides an adapter to make it work as specified here:
  * https://github.com/jhusain/observable-spec
  *

package/src/i18n/tokens.d.ts

@@ -11,8 +11,9 @@ import { InjectionToken } from '../di/injection_token';
  * It is used for i18n extraction, by i18n pipes (DatePipe, I18nPluralPipe, CurrencyPipe,
  * DecimalPipe and PercentPipe) and by ICU expressions.
  *
- * See the {@linkDocs guide/i18n#setting-up-locale i18n guide} for more information.
+ * See the [i18n guide](guide/i18n#setting-up-locale) for more information.
  *
+ * @usageNotes
  * ### Example
  *
  * ```typescript
@@ -32,8 +33,9 @@ export declare const LOCALE_ID: InjectionToken<string>;
  * Use this token at bootstrap to provide the content of your translation file (`xtb`,
  * `xlf` or `xlf2`) when you want to translate your application in another language.
  *
- * See the {@linkDocs guide/i18n#merge i18n guide} for more information.
+ * See the [i18n guide](guide/i18n#merge) for more information.
  *
+ * @usageNotes
  * ### Example
  *
  * ```typescript
@@ -56,8 +58,9 @@ export declare const TRANSLATIONS: InjectionToken<string>;
  * Provide this token at bootstrap to set the format of your {@link TRANSLATIONS}: `xtb`,
  * `xlf` or `xlf2`.
  *
- * See the {@linkDocs guide/i18n#merge i18n guide} for more information.
+ * See the [i18n guide](guide/i18n#merge) for more information.
  *
+ * @usageNotes
  * ### Example
  *
  * ```typescript
@@ -80,8 +83,9 @@ export declare const TRANSLATIONS_FORMAT: InjectionToken<string>;
  * - Warning (default): show a warning in the console and/or shell.
  * - Ignore: do nothing.
  *
- * See the {@linkDocs guide/i18n#missing-translation i18n guide} for more information.
+ * See the [i18n guide](guide/i18n#missing-translation) for more information.
  *
+ * @usageNotes
  * ### Example
  * ```typescript
  * import { MissingTranslationStrategy } from '@angular/core';

package/src/linker/query_list.d.ts

@@ -21,14 +21,14 @@ import { Observable } from 'rxjs';
  *
  * NOTE: In the future this class will implement an `Observable` interface.
  *
- * ### Example ([live demo](http://plnkr.co/edit/RX8sJnQYl9FWuSCWme5z?p=preview))
+ * @usageNotes
+ * ### Example
  * ```typescript
  * @Component({...})
  * class Container {
  *   @ViewChildren(Item) items:QueryList<Item>;
  * }
  * ```
- *
  */
 export declare class QueryList<T> {
     readonly dirty: boolean;

package/src/linker/view_ref.d.ts

@@ -24,9 +24,10 @@ export declare abstract class ViewRef extends ChangeDetectorRef {
  *
  * Properties of elements in a View can change, but the structure (number and order) of elements in
  * a View cannot. Changing the structure of Elements can only be done by inserting, moving or
- * removing nested Views via a {@link ViewContainerRef}. Each View can contain many View Containers.
+ * removing nested Views via a `ViewContainerRef`. Each View can contain many View Containers.
  * <!-- /TODO -->
  *
+ * @usageNotes
  * ### Example
  *
  * Given this template...
@@ -38,9 +39,10 @@ export declare abstract class ViewRef extends ChangeDetectorRef {
  * </ul>
  * ```
  *
- * We have two {@link TemplateRef}s:
+ * We have two `TemplateRef`s:
+ *
+ * Outer `TemplateRef`:
  *
- * Outer {@link TemplateRef}:
  * ```
  * Count: {{items.length}}
  * <ul>
@@ -48,14 +50,15 @@ export declare abstract class ViewRef extends ChangeDetectorRef {
  * </ul>
  * ```
  *
- * Inner {@link TemplateRef}:
+ * Inner `TemplateRef`:
+ *
  * ```
  *   <li>{{item}}</li>
  * ```
  *
- * Notice that the original template is broken down into two separate {@link TemplateRef}s.
+ * Notice that the original template is broken down into two separate `TemplateRef`s.
  *
- * The outer/inner {@link TemplateRef}s are then assembled into views like so:
+ * The outer/inner `TemplateRef`s are then assembled into views like so:
  *
  * ```
  * <!-- ViewRef: outer-0 -->

package/src/metadata/di.d.ts

@@ -13,6 +13,7 @@ import { Type } from '../type';
  * All components that are referenced in the `useValue` value (either directly
  * or in a nested array or map) will be added to the `entryComponents` property.
  *
+ * @usageNotes
  * ### Example
  * The following example shows how the router can populate the `entryComponents`
  * field of an NgModule based on the router configuration which refers
@@ -53,6 +54,7 @@ export interface AttributeDecorator {
      *
      * The directive can inject constant string literals of host element attributes.
      *
+     * @usageNotes
      * ### Example
      *
      * Suppose we have an `<input>` element and want to know its `type`.
@@ -98,14 +100,11 @@ export interface Attribute {
 /**
  * Attribute decorator and metadata.
  *
- *
  * @Annotation
  */
 export declare const Attribute: AttributeDecorator;
 /**
  * Type of the Query metadata.
- *
- *
  */
 export interface Query {
     descendants: boolean;
@@ -117,34 +116,25 @@ export interface Query {
 /**
  * Base class for query metadata.
  *
- * See {@link ContentChildren}, {@link ContentChild}, {@link ViewChildren}, {@link ViewChild} for
- * more information.
- *
- *
+ * @see `ContentChildren`.
+ * @see `ContentChild`.
+ * @see `ViewChildren`.
+ * @see `ViewChild`.
  */
 export declare abstract class Query {
 }
 /**
  * Type of the ContentChildren decorator / constructor function.
  *
- * See {@link ContentChildren}.
- *
- *
+ * @see `ContentChildren`.
  */
 export interface ContentChildrenDecorator {
     /**
-     *
-     * @usageNotes
-     *
-     * {@example core/di/ts/contentChildren/content_children_howto.ts region='HowTo'}
-     *
-     * @description
      * Configures a content query.
      *
-     * You can use ContentChildren to get the {@link QueryList} of elements or directives from the
+     * You can use ContentChildren to get the `QueryList` of elements or directives from the
      * content DOM. Any time a child element is added, removed, or moved, the query list will be
-     * updated,
-     * and the changes observable of the query list will emit a new value.
+     * updated, and the changes observable of the query list will emit a new value.
      *
      * Content queries are set before the `ngAfterContentInit` callback is called.
      *
@@ -154,12 +144,19 @@ export interface ContentChildrenDecorator {
      * * **descendants** - include only direct children or all descendants.
      * * **read** - read a different token from the queried elements.
      *
-     * Let's look at an example:
+     * @usageNotes
+     * ### Basic Example
      *
-     * {@example core/di/ts/contentChildren/content_children_example.ts region='Component'}
+     * Here is a simple demonstration of how the `ContentChildren` decorator can be used.
      *
-     * **npm package**: `@angular/core`
+     * {@example core/di/ts/contentChildren/content_children_howto.ts region='HowTo'}
+     *
+     * ### Tab-pane Example
      *
+     * Here is a slightly more realistic example that shows how `ContentChildren` decorators
+     * can be used to implement a tab pane component.
+     *
+     * {@example core/di/ts/contentChildren/content_children_example.ts region='Component'}
      *
      * @Annotation
      */
@@ -194,12 +191,6 @@ export declare const ContentChildren: ContentChildrenDecorator;
  */
 export interface ContentChildDecorator {
     /**
-     *
-     * @usageNotes
-     *
-     * {@example core/di/ts/contentChild/content_child_howto.ts region='HowTo'}
-     *
-     * @description
      * Configures a content query.
      *
      * You can use ContentChild to get the first element or the directive matching the selector from
@@ -213,12 +204,14 @@ export interface ContentChildDecorator {
      * * **selector** - the directive type or the name used for querying.
      * * **read** - read a different token from the queried element.
      *
-     * Let's look at an example:
+     * @usageNotes
+     * ### Example
      *
-     * {@example core/di/ts/contentChild/content_child_example.ts region='Component'}
+     * {@example core/di/ts/contentChild/content_child_howto.ts region='HowTo'}
      *
-     * **npm package**: `@angular/core`
+     * ### Example
      *
+     * {@example core/di/ts/contentChild/content_child_example.ts region='Component'}
      *
      * @Annotation
      */
@@ -232,7 +225,7 @@ export interface ContentChildDecorator {
 /**
  * Type of the ContentChild metadata.
  *
- * See {@link ContentChild}.
+ * @see `ContentChild`.
  *
  *
  */
@@ -247,21 +240,15 @@ export declare const ContentChild: ContentChildDecorator;
 /**
  * Type of the ViewChildren decorator / constructor function.
  *
- * See {@link ViewChildren}.
+ * @see `ViewChildren`.
  *
  *
  */
 export interface ViewChildrenDecorator {
     /**
-     *
-     * @usageNotes
-     *
-     * {@example core/di/ts/viewChildren/view_children_howto.ts region='HowTo'}
-     *
-     * @description
      * Configures a view query.
      *
-     * You can use ViewChildren to get the {@link QueryList} of elements or directives from the
+     * You can use ViewChildren to get the `QueryList` of elements or directives from the
      * view DOM. Any time a child element is added, removed, or moved, the query list will be updated,
      * and the changes observable of the query list will emit a new value.
      *
@@ -272,12 +259,15 @@ export interface ViewChildrenDecorator {
      * * **selector** - the directive type or the name used for querying.
      * * **read** - read a different token from the queried elements.
      *
-     * Let's look at an example:
+     * @usageNotes
      *
-     * {@example core/di/ts/viewChildren/view_children_example.ts region='Component'}
+     * ### Example
      *
-     * **npm package**: `@angular/core`
+     * {@example core/di/ts/viewChildren/view_children_howto.ts region='HowTo'}
      *
+     * ### Example
+     *
+     * {@example core/di/ts/viewChildren/view_children_example.ts region='Component'}
      *
      * @Annotation
      */
@@ -290,31 +280,21 @@ export interface ViewChildrenDecorator {
 }
 /**
  * Type of the ViewChildren metadata.
- *
- *
  */
 export declare type ViewChildren = Query;
 /**
  * ViewChildren decorator and metadata.
  *
- *
  * @Annotation
  */
 export declare const ViewChildren: ViewChildrenDecorator;
 /**
  * Type of the ViewChild decorator / constructor function.
  *
- * See {@link ViewChild}
- *
- *
+ * @see `ViewChild`.
  */
 export interface ViewChildDecorator {
     /**
-     *
-     * @usageNotes
-     *
-     * {@example core/di/ts/viewChild/view_child_howto.ts region='HowTo'}
-     *
      * @description
      * Configures a view query.
      *
@@ -329,10 +309,15 @@ export interface ViewChildDecorator {
      * * **selector** - the directive type or the name used for querying.
      * * **read** - read a different token from the queried elements.
      *
-     * {@example core/di/ts/viewChild/view_child_example.ts region='Component'}
+     * @usageNotes
+     *
+     * ### Example
+     *
+     * {@example core/di/ts/viewChild/view_child_howto.ts region='HowTo'}
      *
-     * **npm package**: `@angular/core`
+     * ### Example
      *
+     * {@example core/di/ts/viewChild/view_child_example.ts region='Component'}
      *
      * @Annotation
      */
@@ -345,14 +330,11 @@ export interface ViewChildDecorator {
 }
 /**
  * Type of the ViewChild metadata.
- *
- *
  */
 export declare type ViewChild = Query;
 /**
  * ViewChild decorator and metadata.
  *
- *
  * @Annotation
  */
 export declare const ViewChild: ViewChildDecorator;