docs(chore): make styles consistent for API doc headings

Closes #4816
This commit is contained in:
Naomi Black 2015-10-19 15:37:32 +01:00 committed by Naomi Black
parent 2c98a0f771
commit be3e7db5db
58 changed files with 131 additions and 131 deletions

View File

@ -221,7 +221,7 @@ function ngOutletFillContentDirective($compile) {
* ## Use * ## Use
* The directive uses a simple syntax: `ng-link="componentName({ param: paramValue })"` * The directive uses a simple syntax: `ng-link="componentName({ param: paramValue })"`
* *
* ## Example * ### Example
* *
* ```js * ```js
* angular.module('myApp', ['ngComponentRouter']) * angular.module('myApp', ['ngComponentRouter'])

View File

@ -37,7 +37,7 @@ import {BaseException} from 'angular2/src/core/facade/exceptions';
* Token used to bind the component with the top-level {@link RouteConfig}s for the * Token used to bind the component with the top-level {@link RouteConfig}s for the
* application. * application.
* *
* ## Example ([live demo](http://plnkr.co/edit/iRUP8B5OUbxCWQ3AcIDm)) * ### Example ([live demo](http://plnkr.co/edit/iRUP8B5OUbxCWQ3AcIDm))
* *
* ``` * ```
* import {Component} from 'angular2/angular2'; * import {Component} from 'angular2/angular2';
@ -66,7 +66,7 @@ export const ROUTER_PRIMARY_COMPONENT: OpaqueToken =
* {@link RouterLink}, add this to your `directives` array in the {@link View} decorator of your * {@link RouterLink}, add this to your `directives` array in the {@link View} decorator of your
* component. * component.
* *
* ## Example ([live demo](http://plnkr.co/edit/iRUP8B5OUbxCWQ3AcIDm)) * ### Example ([live demo](http://plnkr.co/edit/iRUP8B5OUbxCWQ3AcIDm))
* *
* ``` * ```
* import {Component} from 'angular2/angular2'; * import {Component} from 'angular2/angular2';
@ -88,7 +88,7 @@ export const ROUTER_DIRECTIVES: any[] = CONST_EXPR([RouterOutlet, RouterLink]);
/** /**
* A list of {@link Provider}s. To use the router, you must add this to your application. * A list of {@link Provider}s. To use the router, you must add this to your application.
* *
* ## Example ([live demo](http://plnkr.co/edit/iRUP8B5OUbxCWQ3AcIDm)) * ### Example ([live demo](http://plnkr.co/edit/iRUP8B5OUbxCWQ3AcIDm))
* *
* ``` * ```
* import {Component} from 'angular2/angular2'; * import {Component} from 'angular2/angular2';

View File

@ -72,7 +72,7 @@ export function applicationDomBindings(): Array<Type | Provider | any[]> {
* *
* See {@link PlatformRef} for details on the Angular platform. * See {@link PlatformRef} for details on the Angular platform.
* *
* # Without specified providers *##Without specified providers
* *
* If no providers are specified, `platform`'s behavior depends on whether an existing * If no providers are specified, `platform`'s behavior depends on whether an existing
* platform exists: * platform exists:
@ -83,7 +83,7 @@ export function applicationDomBindings(): Array<Type | Provider | any[]> {
* was created with). This is a convenience feature, allowing for multiple applications * was created with). This is a convenience feature, allowing for multiple applications
* to be loaded into the same platform without awareness of each other. * to be loaded into the same platform without awareness of each other.
* *
* # With specified providers *##With specified providers
* *
* It is also possible to specify providers to be made in the new platform. These providers * It is also possible to specify providers to be made in the new platform. These providers
* will be shared between all applications on the page. For example, an abstraction for * will be shared between all applications on the page. For example, an abstraction for
@ -94,7 +94,7 @@ export function applicationDomBindings(): Array<Type | Provider | any[]> {
* them if a platform did not exist already. If it did exist, however, an error will be * them if a platform did not exist already. If it did exist, however, an error will be
* thrown. * thrown.
* *
* # DOM Applications *##DOM Applications
* *
* This version of `platform` initializes Angular to run in the UI thread, with direct * This version of `platform` initializes Angular to run in the UI thread, with direct
* DOM access. Web-worker applications should call `platform` from * DOM access. Web-worker applications should call `platform` from
@ -208,7 +208,7 @@ export function platform(bindings?: Array<Type | Provider | any[]>): PlatformRef
* to that application. * to that application.
* *
* *
* # API *##API
* - `appComponentType`: The root component which should act as the application. This is * - `appComponentType`: The root component which should act as the application. This is
* a reference to a `Type` which is annotated with `@Component(...)`. * a reference to a `Type` which is annotated with `@Component(...)`.
* - `componentInjectableBindings`: An additional set of providers that can be added to the * - `componentInjectableBindings`: An additional set of providers that can be added to the

View File

@ -159,20 +159,20 @@ export abstract class PlatformRef {
/** /**
* Instantiate a new Angular application on the page. * Instantiate a new Angular application on the page.
* *
* # What is an application? *##What is an application?
* *
* Each Angular application has its own zone, change detection, compiler, * Each Angular application has its own zone, change detection, compiler,
* renderer, and other framework components. An application hosts one or more * renderer, and other framework components. An application hosts one or more
* root components, which can be initialized via `ApplicationRef.bootstrap()`. * root components, which can be initialized via `ApplicationRef.bootstrap()`.
* *
* # Application Bindings *##Application Bindings
* *
* Angular applications require numerous providers to be properly instantiated. * Angular applications require numerous providers to be properly instantiated.
* When using `application()` to create a new app on the page, these providers * When using `application()` to create a new app on the page, these providers
* must be provided. Fortunately, there are helper functions to configure * must be provided. Fortunately, there are helper functions to configure
* typical providers, as shown in the example below. * typical providers, as shown in the example below.
* *
* # Example * ### Example
* ``` * ```
* var myAppBindings = [MyAppService]; * var myAppBindings = [MyAppService];
* *
@ -180,7 +180,7 @@ export abstract class PlatformRef {
* .application([applicationCommonBindings(), applicationDomBindings(), myAppBindings]) * .application([applicationCommonBindings(), applicationDomBindings(), myAppBindings])
* .bootstrap(MyTopLevelComponent); * .bootstrap(MyTopLevelComponent);
* ``` * ```
* # See Also *##See Also
* *
* See the {@link bootstrap} documentation for more details. * See the {@link bootstrap} documentation for more details.
*/ */
@ -191,7 +191,7 @@ export abstract class PlatformRef {
* are only available asynchronously. One such use case is to initialize an * are only available asynchronously. One such use case is to initialize an
* application running in a web worker. * application running in a web worker.
* *
* # Usage *##Usage
* *
* `bindingFn` is a function that will be called in the new application's zone. * `bindingFn` is a function that will be called in the new application's zone.
* It should return a `Promise` to a list of providers to be used for the * It should return a `Promise` to a list of providers to be used for the
@ -281,19 +281,19 @@ export abstract class ApplicationRef {
/** /**
* Bootstrap a new component at the root level of the application. * Bootstrap a new component at the root level of the application.
* *
* # Bootstrap process *##Bootstrap process
* *
* When bootstrapping a new root component into an application, Angular mounts the * When bootstrapping a new root component into an application, Angular mounts the
* specified application component onto DOM elements identified by the [componentType]'s * specified application component onto DOM elements identified by the [componentType]'s
* selector and kicks off automatic change detection to finish initializing the component. * selector and kicks off automatic change detection to finish initializing the component.
* *
* # Optional Bindings *##Optional Bindings
* *
* Bindings for the given component can optionally be overridden via the `providers` * Bindings for the given component can optionally be overridden via the `providers`
* parameter. These providers will only apply for the root component being added and any * parameter. These providers will only apply for the root component being added and any
* child components under it. * child components under it.
* *
* # Example * ### Example
* ``` * ```
* var app = platform.application([applicationCommonBindings(), applicationDomBindings()]; * var app = platform.application([applicationCommonBindings(), applicationDomBindings()];
* app.bootstrap(FirstRootComponent); * app.bootstrap(FirstRootComponent);

View File

@ -44,7 +44,7 @@ export class IterableDiffers {
* which will only be applied to the injector for this component and its children. * which will only be applied to the injector for this component and its children.
* This step is all that's required to make a new {@link IterableDiffer} available. * This step is all that's required to make a new {@link IterableDiffer} available.
* *
* # Example * ### Example
* *
* ``` * ```
* @Component({ * @Component({

View File

@ -44,7 +44,7 @@ export class KeyValueDiffers {
* which will only be applied to the injector for this component and its children. * which will only be applied to the injector for this component and its children.
* This step is all that's required to make a new {@link KeyValueDiffer} available. * This step is all that's required to make a new {@link KeyValueDiffer} available.
* *
* # Example * ### Example
* *
* ``` * ```
* @Component({ * @Component({

View File

@ -23,7 +23,7 @@ import {isPresent, isBlank} from 'angular2/src/core/facade/lang';
* * When an item is removed, its template instance is removed from the DOM. * * When an item is removed, its template instance is removed from the DOM.
* * When items are reordered, their respective templates are reordered in the DOM. * * When items are reordered, their respective templates are reordered in the DOM.
* *
* # Example * ### Example
* *
* ``` * ```
* <ul> * <ul>
@ -33,7 +33,7 @@ import {isPresent, isBlank} from 'angular2/src/core/facade/lang';
* </ul> * </ul>
* ``` * ```
* *
* # Syntax *##Syntax
* *
* - `<li *ng-for="#item of items; #i = index">...</li>` * - `<li *ng-for="#item of items; #i = index">...</li>`
* - `<li template="ng-for #item of items; #i = index">...</li>` * - `<li template="ng-for #item of items; #i = index">...</li>`

View File

@ -18,7 +18,7 @@ import {isBlank} from 'angular2/src/core/facade/lang';
* </div> * </div>
* ``` * ```
* *
* # Syntax *##Syntax
* *
* - `<div *ng-if="condition">...</div>` * - `<div *ng-if="condition">...</div>`
* - `<div template="ng-if condition">...</div>` * - `<div template="ng-if condition">...</div>`

View File

@ -15,7 +15,7 @@ import {isPresent, isBlank, print} from 'angular2/src/core/facade/lang';
* corresponding element styles are updated based on changes to this object. Style names to update * corresponding element styles are updated based on changes to this object. Style names to update
* are taken from the object's keys, and values - from the corresponding object's values. * are taken from the object's keys, and values - from the corresponding object's values.
* *
* # Syntax *##Syntax
* *
* - `<div [ng-style]="{'font-style': style}"></div>` * - `<div [ng-style]="{'font-style': style}"></div>`
* - `<div [ng-style]="styleExp"></div>` - here the `styleExp` must evaluate to an object * - `<div [ng-style]="styleExp"></div>` - here the `styleExp` must evaluate to an object

View File

@ -29,7 +29,7 @@ export class SwitchView {
* evaluated. If a matching expression is not found via a when attribute then an element with the * evaluated. If a matching expression is not found via a when attribute then an element with the
* default attribute is displayed. * default attribute is displayed.
* *
* # Example: * ### Example
* *
* ``` * ```
* <ANY [ng-switch]="expression"> * <ANY [ng-switch]="expression">

View File

@ -49,7 +49,7 @@ export class Observable {
/** /**
* Use by directives and components to emit custom Events. * Use by directives and components to emit custom Events.
* *
* ## Examples * ### Examples
* *
* In the following example, `Zippy` alternatively emits `open` and `close` events when its * In the following example, `Zippy` alternatively emits `open` and `close` events when its
* title gets clicked: * title gets clicked:

View File

@ -17,7 +17,7 @@ class _ArrayLogger {
* intercept error handling, * intercept error handling,
* write a custom exception handler that replaces this default as appropriate for your app. * write a custom exception handler that replaces this default as appropriate for your app.
* *
* # Example * ### Example
* *
* ```javascript * ```javascript
* *

View File

@ -47,7 +47,7 @@ import {CONST_EXPR, Type} from './facade/lang';
/** /**
* Shorthand set of providers used for building Angular forms. * Shorthand set of providers used for building Angular forms.
* *
* ### Example: * ### Example
* *
* ```typescript * ```typescript
* bootstrap(MyApp, [FORM_PROVIDERS]); * bootstrap(MyApp, [FORM_PROVIDERS]);

View File

@ -38,7 +38,7 @@ export {NgControlStatus} from './directives/ng_control_status';
* *
* This is a shorthand for importing them each individually. * This is a shorthand for importing them each individually.
* *
* ### Example: * ### Example
* *
* ```typescript * ```typescript
* @Component({ * @Component({

View File

@ -13,7 +13,7 @@ const CHECKBOX_VALUE_ACCESSOR = CONST_EXPR(new Provider(
/** /**
* The accessor for writing a value and listening to changes on a checkbox input element. * The accessor for writing a value and listening to changes on a checkbox input element.
* *
* # Example * ### Example
* ``` * ```
* <input type="checkbox" [ng-control]="rememberLogin"> * <input type="checkbox" [ng-control]="rememberLogin">
* ``` * ```

View File

@ -13,7 +13,7 @@ const DEFAULT_VALUE_ACCESSOR = CONST_EXPR(new Provider(
* The default accessor for writing a value and listening to changes that is used by the * The default accessor for writing a value and listening to changes that is used by the
* {@link NgModel}, {@link NgFormControl}, and {@link NgControlName} directives. * {@link NgModel}, {@link NgFormControl}, and {@link NgControlName} directives.
* *
* # Example * ### Example
* ``` * ```
* <input type="text" [(ng-model)]="searchQuery"> * <input type="text" [(ng-model)]="searchQuery">
* ``` * ```

View File

@ -17,7 +17,7 @@ const controlGroupBinding =
* *
* This directive can only be used as a child of {@link NgForm} or {@link NgFormModel}. * This directive can only be used as a child of {@link NgForm} or {@link NgFormModel}.
* *
* # Example * ### Example
* *
* In this example, we create the credentials and personal control groups. * In this example, we create the credentials and personal control groups.
* We can work with each group separately: check its validity, get its value, listen to its changes. * We can work with each group separately: check its validity, get its value, listen to its changes.

View File

@ -21,7 +21,7 @@ const controlNameBinding =
* *
* This directive can only be used as a child of {@link NgForm} or {@link NgFormModel}. * This directive can only be used as a child of {@link NgForm} or {@link NgFormModel}.
* # Example * ### Example
* *
* In this example, we create the login and password controls. * In this example, we create the login and password controls.
* We can work with each control separately: check its validity, get its value, listen to its * We can work with each control separately: check its validity, get its value, listen to its

View File

@ -22,19 +22,19 @@ const formDirectiveProvider =
* If `NgForm` is bound in a component, `<form>` elements in that component will be * If `NgForm` is bound in a component, `<form>` elements in that component will be
* upgraded to use the Angular form system. * upgraded to use the Angular form system.
* *
* # Typical Use *##Typical Use
* *
* Include `FORM_DIRECTIVES` in the `directives` section of a {@link View} annotation * Include `FORM_DIRECTIVES` in the `directives` section of a {@link View} annotation
* to use `NgForm` and its associated controls. * to use `NgForm` and its associated controls.
* *
* # Structure *##Structure
* *
* An Angular form is a collection of `Control`s in some hierarchy. * An Angular form is a collection of `Control`s in some hierarchy.
* `Control`s can be at the top level or can be organized in `ControlGroup`s * `Control`s can be at the top level or can be organized in `ControlGroup`s
* or `ControlArray`s. This hierarchy is reflected in the form's `value`, a * or `ControlArray`s. This hierarchy is reflected in the form's `value`, a
* JSON object that mirrors the form structure. * JSON object that mirrors the form structure.
* *
* # Submission *##Submission
* *
* The `ng-submit` event signals when the user triggers a form submission. * The `ng-submit` event signals when the user triggers a form submission.
* *

View File

@ -42,7 +42,7 @@ const formControlBinding =
* } * }
* ``` * ```
* *
* # ng-model *##ng-model
* *
* We can also use `ng-model` to bind a domain model to the form. * We can also use `ng-model` to bind a domain model to the form.
* *

View File

@ -16,7 +16,7 @@ const formControlBinding =
/** /**
* Binds a domain model to a form control. * Binds a domain model to a form control.
* *
* # Usage *##Usage
* *
* `ng-model` binds an existing domain model to a form control. For a * `ng-model` binds an existing domain model to a form control. For a
* two-way binding, use `[(ng-model)]` to ensure the model updates in * two-way binding, use `[(ng-model)]` to ensure the model updates in

View File

@ -13,7 +13,7 @@ const NUMBER_VALUE_ACCESSOR = CONST_EXPR(new Provider(
* The accessor for writing a number value and listening to changes that is used by the * The accessor for writing a number value and listening to changes that is used by the
* {@link NgModel}, {@link NgFormControl}, and {@link NgControlName} directives. * {@link NgModel}, {@link NgFormControl}, and {@link NgControlName} directives.
* *
* # Example * ### Example
* ``` * ```
* <input type="number" [(ng-model)]="age"> * <input type="number" [(ng-model)]="age">
* ``` * ```

View File

@ -14,7 +14,7 @@ const SELECT_VALUE_ACCESSOR = CONST_EXPR(new Provider(
/** /**
* Marks `<option>` as dynamic, so Angular can be notified when options change. * Marks `<option>` as dynamic, so Angular can be notified when options change.
* *
* #Example: * ### Example
* *
* ``` * ```
* <select ng-control="city"> * <select ng-control="city">

View File

@ -7,7 +7,7 @@ import * as modelModule from './model';
/** /**
* Creates a form object from a user-specified configuration. * Creates a form object from a user-specified configuration.
* *
* # Example * ### Example
* *
* ``` * ```
* import {Component, bootstrap} from 'angular2/angular2'; * import {Component, bootstrap} from 'angular2/angular2';

View File

@ -38,7 +38,7 @@ function _find(control: AbstractControl, path: Array<string | number>| string) {
} }
/** /**
* Omitting from external API doc as this is really an abstract internal concept. *
*/ */
export class AbstractControl { export class AbstractControl {
/** @internal */ /** @internal */
@ -145,7 +145,7 @@ export class AbstractControl {
* `Control` is one of the three fundamental building blocks used to define forms in Angular, along * `Control` is one of the three fundamental building blocks used to define forms in Angular, along
* with {@link ControlGroup} and {@link ControlArray}. * with {@link ControlGroup} and {@link ControlArray}.
* *
* # Usage *##Usage
* *
* By default, a `Control` is created for every `<input>` or other form component. * By default, a `Control` is created for every `<input>` or other form component.
* With {@link NgFormControl} or {@link NgFormModel} an existing {@link Control} can be * With {@link NgFormControl} or {@link NgFormModel} an existing {@link Control} can be
@ -287,7 +287,7 @@ export class ControlGroup extends AbstractControl {
* along with {@link Control} and {@link ControlGroup}. {@link ControlGroup} can also contain * along with {@link Control} and {@link ControlGroup}. {@link ControlGroup} can also contain
* other controls, but is of fixed length. * other controls, but is of fixed length.
* *
* # Adding or removing controls *##Adding or removing controls
* *
* To change the controls in the array, use the `push`, `insert`, or `removeAt` methods * To change the controls in the array, use the `push`, `insert`, or `removeAt` methods
* in `ControlArray` itself. These methods ensure the controls are properly tracked in the * in `ControlArray` itself. These methods ensure the controls are properly tracked in the

View File

@ -10,7 +10,7 @@ export const NG_VALIDATORS: OpaqueToken = CONST_EXPR(new OpaqueToken("NgValidato
/** /**
* Provides a set of validators used by form controls. * Provides a set of validators used by form controls.
* *
* # Example * ### Example
* *
* ``` * ```
* var loginControl = new Control("", Validators.required) * var loginControl = new Control("", Validators.required)

View File

@ -15,7 +15,7 @@ import {wtfLeave, wtfCreateScope, WtfScopeFn} from '../profile/profile';
* *
* Each Angular application has a single `LifeCycle` instance. * Each Angular application has a single `LifeCycle` instance.
* *
* # Example * ### Example
* *
* This is a contrived example, since the bootstrap automatically runs inside of the `Zone`, which * This is a contrived example, since the bootstrap automatically runs inside of the `Zone`, which
* invokes * invokes

View File

@ -107,7 +107,7 @@ export abstract class DynamicComponentLoader {
* Returns a promise for the {@link ComponentRef} representing the newly created Component. * Returns a promise for the {@link ComponentRef} representing the newly created Component.
* *
* *
* ## Example * ### Example
* *
* ``` * ```
* @ng.Component({ * @ng.Component({
@ -167,7 +167,7 @@ export abstract class DynamicComponentLoader {
* Returns a promise for the {@link ComponentRef} representing the newly created Component. * Returns a promise for the {@link ComponentRef} representing the newly created Component.
* *
* *
* ## Example * ### Example
* *
* ``` * ```
* @ng.Component({ * @ng.Component({
@ -221,7 +221,7 @@ export abstract class DynamicComponentLoader {
* Returns a promise for the {@link ComponentRef} representing the newly created Component. * Returns a promise for the {@link ComponentRef} representing the newly created Component.
* *
* *
* ## Example * ### Example
* *
* ``` * ```
* @ng.Component({ * @ng.Component({

View File

@ -76,7 +76,7 @@ export abstract class AppViewManager {
* Use {@link AppViewManager#destroyRootHostView} to destroy the created Component and it's Host * Use {@link AppViewManager#destroyRootHostView} to destroy the created Component and it's Host
* View. * View.
* *
* ## Example * ### Example
* *
* ``` * ```
* @ng.Component({ * @ng.Component({

View File

@ -43,7 +43,7 @@ export interface HostViewRef {
* removing nested Views via a {@link ViewContainer}. Each View can contain many View Containers. * removing nested Views via a {@link ViewContainer}. Each View can contain many View Containers.
* <!-- /TODO --> * <!-- /TODO -->
* *
* ## Example * ### Example
* *
* Given this template... * Given this template...
* *
@ -139,7 +139,7 @@ export class ViewRef_ extends ViewRef {
* {@link Compiler#compileInHost} API. * {@link Compiler#compileInHost} API.
* *
* *
* ## Example * ### Example
* *
* Given this template: * Given this template:
* *

View File

@ -107,7 +107,7 @@ export interface ViewDecorator extends TypeDecorator {
/** /**
* {@link DirectiveMetadata} factory for creating annotations, decorators or DSL. * {@link DirectiveMetadata} factory for creating annotations, decorators or DSL.
* *
* ## Example as TypeScript Decorator * ### Example as TypeScript Decorator
* *
* ``` * ```
* import {Directive} from "angular2/angular2"; * import {Directive} from "angular2/angular2";
@ -120,7 +120,7 @@ export interface ViewDecorator extends TypeDecorator {
* } * }
* ``` * ```
* *
* ## Example as ES5 DSL * ### Example as ES5 DSL
* *
* ``` * ```
* var MyDirective = ng * var MyDirective = ng
@ -132,7 +132,7 @@ export interface ViewDecorator extends TypeDecorator {
* }) * })
* ``` * ```
* *
* ## Example as ES5 annotation * ### Example as ES5 annotation
* *
* ``` * ```
* var MyDirective = function() { * var MyDirective = function() {
@ -176,7 +176,7 @@ export interface DirectiveFactory {
/** /**
* {@link ComponentMetadata} factory for creating annotations, decorators or DSL. * {@link ComponentMetadata} factory for creating annotations, decorators or DSL.
* *
* ## Example as TypeScript Decorator * ### Example as TypeScript Decorator
* *
* ``` * ```
* import {Component} from "angular2/angular2"; * import {Component} from "angular2/angular2";
@ -189,7 +189,7 @@ export interface DirectiveFactory {
* } * }
* ``` * ```
* *
* ## Example as ES5 DSL * ### Example as ES5 DSL
* *
* ``` * ```
* var MyComponent = ng * var MyComponent = ng
@ -201,7 +201,7 @@ export interface DirectiveFactory {
* }) * })
* ``` * ```
* *
* ## Example as ES5 annotation * ### Example as ES5 annotation
* *
* ``` * ```
* var MyComponent = function() { * var MyComponent = function() {
@ -268,7 +268,7 @@ export interface ComponentFactory {
/** /**
* {@link ViewMetadata} factory for creating annotations, decorators or DSL. * {@link ViewMetadata} factory for creating annotations, decorators or DSL.
* *
* ## Example as TypeScript Decorator * ### Example as TypeScript Decorator
* *
* ``` * ```
* import {Component, View} from "angular2/angular2"; * import {Component, View} from "angular2/angular2";
@ -282,7 +282,7 @@ export interface ComponentFactory {
* } * }
* ``` * ```
* *
* ## Example as ES5 DSL * ### Example as ES5 DSL
* *
* ``` * ```
* var MyComponent = ng * var MyComponent = ng
@ -295,7 +295,7 @@ export interface ComponentFactory {
* }) * })
* ``` * ```
* *
* ## Example as ES5 annotation * ### Example as ES5 annotation
* *
* ``` * ```
* var MyComponent = function() { * var MyComponent = function() {
@ -332,7 +332,7 @@ export interface ViewFactory {
/** /**
* {@link AttributeMetadata} factory for creating annotations, decorators or DSL. * {@link AttributeMetadata} factory for creating annotations, decorators or DSL.
* *
* ## Example as TypeScript Decorator * ### Example as TypeScript Decorator
* *
* ``` * ```
* import {Attribute, Component} from "angular2/angular2"; * import {Attribute, Component} from "angular2/angular2";
@ -345,7 +345,7 @@ export interface ViewFactory {
* } * }
* ``` * ```
* *
* ## Example as ES5 DSL * ### Example as ES5 DSL
* *
* ``` * ```
* var MyComponent = ng * var MyComponent = ng
@ -357,7 +357,7 @@ export interface ViewFactory {
* }) * })
* ``` * ```
* *
* ## Example as ES5 annotation * ### Example as ES5 annotation
* *
* ``` * ```
* var MyComponent = function(title) { * var MyComponent = function(title) {
@ -449,7 +449,7 @@ export interface ViewChildFactory {
/** /**
* {@link PipeMetadata} factory for creating decorators. * {@link PipeMetadata} factory for creating decorators.
* *
* ## Example as TypeScript Decorator * ### Example as TypeScript Decorator
* *
* ``` * ```
* import {Pipe} from "angular2/angular2"; * import {Pipe} from "angular2/angular2";
@ -528,7 +528,7 @@ export interface HostListenerFactory {
* When the component class implements some {@link angular2/lifecycle_hooks} the callbacks are * When the component class implements some {@link angular2/lifecycle_hooks} the callbacks are
* called by the change detection at defined points in time during the life of the component. * called by the change detection at defined points in time during the life of the component.
* *
* ## Example * ### Example
* *
* ``` * ```
* @Component({ * @Component({
@ -613,7 +613,7 @@ export var Component: ComponentFactory =
* {@link DirectiveMetadata} directives only * {@link DirectiveMetadata} directives only
* - `bindingPropagation: BindingPropagation` to control change detection in a more granular way. * - `bindingPropagation: BindingPropagation` to control change detection in a more granular way.
* *
* ## Example * ### Example
* *
* The following example demonstrates how dependency injection resolves constructor arguments in * The following example demonstrates how dependency injection resolves constructor arguments in
* practice. * practice.
@ -782,7 +782,7 @@ export var Component: ComponentFactory =
* If none can be * If none can be
* found, the injector supplies `null` instead of throwing an error. * found, the injector supplies `null` instead of throwing an error.
* *
* ## Example * ### Example
* *
* Here we use a decorator directive to simply define basic tool-tip behavior. * Here we use a decorator directive to simply define basic tool-tip behavior.
* *
@ -870,7 +870,7 @@ export var Component: ComponentFactory =
* When the directive class implements some {@link angular2/lifecycle_hooks} the callbacks are * When the directive class implements some {@link angular2/lifecycle_hooks} the callbacks are
* called by the change detection at defined points in time during the life of the directive. * called by the change detection at defined points in time during the life of the directive.
* *
* ## Example * ### Example
* *
* Let's suppose we want to implement the `unless` behavior, to conditionally include a template. * Let's suppose we want to implement the `unless` behavior, to conditionally include a template.
* *
@ -942,7 +942,7 @@ export var Directive: DirectiveFactory = <DirectiveFactory>makeDecorator(Directi
* *
* For details on the `@Component` annotation, see {@link ComponentMetadata}. * For details on the `@Component` annotation, see {@link ComponentMetadata}.
* *
* ## Example * ### Example
* *
* ``` * ```
* @Component({ * @Component({
@ -975,7 +975,7 @@ export var View: ViewFactory =
* *
* For details on the `@Component` annotation, see {@link ComponentMetadata}. * For details on the `@Component` annotation, see {@link ComponentMetadata}.
* *
* ## Example * ### Example
* *
* ``` * ```
* @Component({ * @Component({
@ -1242,7 +1242,7 @@ export var ViewQuery: QueryFactory = makeParamDecorator(ViewQueryMetadata);
/** /**
* Declare reusable pipe function. * Declare reusable pipe function.
* *
* ## Example * ### Example
* *
* ``` * ```
* @Pipe({ * @Pipe({

View File

@ -14,7 +14,7 @@ import {DependencyMetadata} from 'angular2/src/core/di/metadata';
* *
* The directive can inject constant string literals of host element attributes. * The directive can inject constant string literals of host element attributes.
* *
* ## Example * ### Example
* *
* Suppose we have an `<input>` element and want to know its `type`. * Suppose we have an `<input>` element and want to know its `type`.
* *

View File

@ -67,7 +67,7 @@ import {ViewEncapsulation} from 'angular2/src/core/metadata/view';
* {@link DirectiveMetadata} directives only * {@link DirectiveMetadata} directives only
* - `bindingPropagation: BindingPropagation` to control change detection in a more granular way. * - `bindingPropagation: BindingPropagation` to control change detection in a more granular way.
* *
* ## Example * ### Example
* *
* The following example demonstrates how dependency injection resolves constructor arguments in * The following example demonstrates how dependency injection resolves constructor arguments in
* practice. * practice.
@ -236,7 +236,7 @@ import {ViewEncapsulation} from 'angular2/src/core/metadata/view';
* If none can be * If none can be
* found, the injector supplies `null` instead of throwing an error. * found, the injector supplies `null` instead of throwing an error.
* *
* ## Example * ### Example
* *
* Here we use a decorator directive to simply define basic tool-tip behavior. * Here we use a decorator directive to simply define basic tool-tip behavior.
* *
@ -324,7 +324,7 @@ import {ViewEncapsulation} from 'angular2/src/core/metadata/view';
* When the directive class implements some {@link angular2/lifecycle_hooks} the callbacks are * When the directive class implements some {@link angular2/lifecycle_hooks} the callbacks are
* called by the change detection at defined points in time during the life of the directive. * called by the change detection at defined points in time during the life of the directive.
* *
* ## Example * ### Example
* *
* Let's suppose we want to implement the `unless` behavior, to conditionally include a template. * Let's suppose we want to implement the `unless` behavior, to conditionally include a template.
* *
@ -399,7 +399,7 @@ export class DirectiveMetadata extends InjectableMetadata {
* - `selector1, selector2`: select if either `selector1` or `selector2` matches. * - `selector1, selector2`: select if either `selector1` or `selector2` matches.
* *
* *
* ## Example * ### Example
* *
* Suppose we have a directive with an `input[type=text]` selector. * Suppose we have a directive with an `input[type=text]` selector.
* *
@ -802,7 +802,7 @@ export class DirectiveMetadata extends InjectableMetadata {
* When the component class implements some {@link angular2/lifecycle_hooks} the callbacks are * When the component class implements some {@link angular2/lifecycle_hooks} the callbacks are
* called by the change detection at defined points in time during the life of the component. * called by the change detection at defined points in time during the life of the component.
* *
* ## Example * ### Example
* *
* ``` * ```
* @Component({ * @Component({
@ -948,7 +948,7 @@ export class ComponentMetadata extends DirectiveMetadata {
/** /**
* Declare reusable pipe function. * Declare reusable pipe function.
* *
* ## Example * ### Example
* *
* ``` * ```
* @Pipe({ * @Pipe({

View File

@ -44,7 +44,7 @@ export var VIEW_ENCAPSULATION_VALUES =
* *
* For details on the `@Component` annotation, see {@link ComponentMetadata}. * For details on the `@Component` annotation, see {@link ComponentMetadata}.
* *
* ## Example * ### Example
* *
* ``` * ```
* @Component({ * @Component({
@ -96,7 +96,7 @@ export class ViewMetadata {
* *
* Directives must be listed explicitly to provide proper component encapsulation. * Directives must be listed explicitly to provide proper component encapsulation.
* *
* ## Example * ### Example
* *
* ```javascript * ```javascript
* @Component({ * @Component({

View File

@ -40,7 +40,7 @@ var _observableStrategy = new ObservableStrategy();
* emitted. * emitted.
* When a new value is emitted, the `async` pipe marks the component to be checked for changes. * When a new value is emitted, the `async` pipe marks the component to be checked for changes.
* *
* # Example * ### Example
* The example below binds the `time` Observable to the view. Every 500ms, the `time` Observable * The example below binds the `time` Observable to the view. Every 500ms, the `time` Observable
* updates the view with the current time. * updates the view with the current time.
* *

View File

@ -26,7 +26,7 @@ var defaultLocale: string = 'en-US';
* *
* Formats a date value to a string based on the requested format. * Formats a date value to a string based on the requested format.
* *
* # Usage *##Usage
* *
* expression | date[:format] * expression | date[:format]
* *
@ -67,7 +67,7 @@ var defaultLocale: string = 'en-US';
* *
* Timezone of the formatted text will be the local system timezone of the end-users machine. * Timezone of the formatted text will be the local system timezone of the end-users machine.
* *
* # Examples * ### Examples
* *
* Assuming `dateObj` is (year: 2015, month: 6, day: 15, hour: 21, minute: 43, second: 11) * Assuming `dateObj` is (year: 2015, month: 6, day: 15, hour: 21, minute: 43, second: 11)
* in the _local_ time and locale is 'en-US': * in the _local_ time and locale is 'en-US':

View File

@ -6,7 +6,7 @@ import {Pipe} from 'angular2/src/core/metadata';
/** /**
* Implements json transforms to any object. * Implements json transforms to any object.
* *
* # Example * ### Example
* *
* In this example we transform the user object to json. * In this example we transform the user object to json.
* *

View File

@ -8,7 +8,7 @@ import {InvalidPipeArgumentException} from './invalid_pipe_argument_exception';
/** /**
* Implements lowercase transforms to text. * Implements lowercase transforms to text.
* *
* # Example * ### Example
* *
* In this example we transform the user text lowercase. * In this example we transform the user text lowercase.
* *

View File

@ -62,7 +62,7 @@ export class NumberPipe {
* Formats a number as local text. i.e. group sizing and separator and other locale-specific * Formats a number as local text. i.e. group sizing and separator and other locale-specific
* configurations are based on the active locale. * configurations are based on the active locale.
* *
* # Usage *##Usage
* *
* expression | number[:digitInfo] * expression | number[:digitInfo]
* *
@ -77,7 +77,7 @@ export class NumberPipe {
* For more information on the acceptable range for each of these numbers and other * For more information on the acceptable range for each of these numbers and other
* details see your native internationalization library. * details see your native internationalization library.
* *
* # Examples * ### Examples
* *
* {{ 123 | number }} // output is 123 * {{ 123 | number }} // output is 123
* {{ 123.1 | number: '.2-3' }} // output is 123.10 * {{ 123.1 | number: '.2-3' }} // output is 123.10
@ -99,7 +99,7 @@ export class DecimalPipe extends NumberPipe implements PipeTransform {
* *
* Formats a number as local percent. * Formats a number as local percent.
* *
* # Usage *##Usage
* *
* expression | percent[:digitInfo] * expression | percent[:digitInfo]
* *
@ -121,7 +121,7 @@ export class PercentPipe extends NumberPipe implements PipeTransform {
* *
* Formats a number as local currency. * Formats a number as local currency.
* *
* # Usage *##Usage
* *
* expression | currency[:currencyCode[:symbolDisplay[:digitInfo]]] * expression | currency[:currencyCode[:symbolDisplay[:digitInfo]]]
* *

View File

@ -16,7 +16,7 @@ import {Pipe} from '../metadata';
* *
* The ending index of the subset to return is specified by the optional `end` parameter. * The ending index of the subset to return is specified by the optional `end` parameter.
* *
* # Usage *##Usage
* *
* expression | slice:start[:end] * expression | slice:start[:end]
* *
@ -44,7 +44,7 @@ import {Pipe} from '../metadata';
* When operating on a [List], the returned list is always a copy even when all * When operating on a [List], the returned list is always a copy even when all
* the elements are being returned. * the elements are being returned.
* *
* # Examples * ### Examples
* *
* ## List Example * ## List Example
* *

View File

@ -7,7 +7,7 @@ import {InvalidPipeArgumentException} from './invalid_pipe_argument_exception';
/** /**
* Implements uppercase transforms to text. * Implements uppercase transforms to text.
* *
* # Example * ### Example
* *
* In this example we transform the user text uppercase. * In this example we transform the user text uppercase.
* *

View File

@ -167,7 +167,7 @@ function applyParams(fnOrArray: (Function | any[]), key: string): Function {
* } * }
* ``` * ```
* *
* ## Example with parameter annotations * ### Example with parameter annotations
* *
* ``` * ```
* var MyService = ng.Class({ * var MyService = ng.Class({
@ -187,7 +187,7 @@ function applyParams(fnOrArray: (Function | any[]), key: string): Function {
* } * }
* ``` * ```
* *
* ## Example with inheritance * ### Example with inheritance
* *
* ``` * ```
* var Shape = ng.Class({ * var Shape = ng.Class({

View File

@ -43,7 +43,7 @@ export class MockConnection implements Connection {
* Sends a mock response to the connection. This response is the value that is emitted to the * Sends a mock response to the connection. This response is the value that is emitted to the
* {@link EventEmitter} returned by {@link Http}. * {@link EventEmitter} returned by {@link Http}.
* *
* #Example * ### Example
* *
* ``` * ```
* var connection; * var connection;
@ -94,7 +94,7 @@ export class MockConnection implements Connection {
* This class can be injected in tests, and should be used to override providers * This class can be injected in tests, and should be used to override providers
* to other backends, such as {@link XHRBackend}. * to other backends, such as {@link XHRBackend}.
* *
* #Example * ### Example
* *
* ``` * ```
* import {MockBackend, DefaultOptions, Http} from 'angular2/http'; * import {MockBackend, DefaultOptions, Http} from 'angular2/http';
@ -126,7 +126,7 @@ export class MockBackend implements ConnectionBackend {
* of {@link MockConnection} instances that have been created by this backend. Can be subscribed * of {@link MockConnection} instances that have been created by this backend. Can be subscribed
* to in order to respond to connections. * to in order to respond to connections.
* *
* #Example * ### Example
* *
* ``` * ```
* import {MockBackend, Http, BaseRequestOptions} from 'angular2/http'; * import {MockBackend, Http, BaseRequestOptions} from 'angular2/http';

View File

@ -88,7 +88,7 @@ export class XHRConnection implements Connection {
* overridden if a different backend implementation should be used, * overridden if a different backend implementation should be used,
* such as in a node backend. * such as in a node backend.
* *
* #Example * ### Example
* *
* ``` * ```
* import {Http, MyNodeBackend, HTTP_PROVIDERS, BaseRequestOptions} from 'angular2/http'; * import {Http, MyNodeBackend, HTTP_PROVIDERS, BaseRequestOptions} from 'angular2/http';

View File

@ -72,7 +72,7 @@ export class RequestOptions {
* the `options` object. If these values should be merged, it should be done prior to calling * the `options` object. If these values should be merged, it should be done prior to calling
* `merge` on the `RequestOptions` instance. * `merge` on the `RequestOptions` instance.
* *
* Example ([live demo](http://plnkr.co/edit/6w8XA8YTkDRcPYpdB9dk?p=preview)) * ### Example ([live demo](http://plnkr.co/edit/6w8XA8YTkDRcPYpdB9dk?p=preview))
* *
* ```typescript * ```typescript
* import {RequestOptions, Request, RequestMethods} from 'angular2/http'; * import {RequestOptions, Request, RequestMethods} from 'angular2/http';

View File

@ -72,7 +72,7 @@ export class ResponseOptions {
* This may be useful when sharing a base `ResponseOptions` object inside tests, * This may be useful when sharing a base `ResponseOptions` object inside tests,
* where certain properties may change from test to test. * where certain properties may change from test to test.
* *
* Example ([live demo](http://plnkr.co/edit/1lXquqFfgduTFBWjNoRE?p=preview)) * ### Example ([live demo](http://plnkr.co/edit/1lXquqFfgduTFBWjNoRE?p=preview))
* *
* ```typescript * ```typescript
* import {ResponseOptions, Response} from 'angular2/http'; * import {ResponseOptions, Response} from 'angular2/http';

View File

@ -36,7 +36,7 @@ function mergeOptions(defaultOpts, providedOpts, method, url): RequestOptions {
* `request` returns an {@link Observable} which will emit a single {@link Response} when a * `request` returns an {@link Observable} which will emit a single {@link Response} when a
* response is received. * response is received.
* *
* #Example * ### Example
* *
* ```typescript * ```typescript
* import {Http, HTTP_PROVIDERS} from 'angular2/http'; * import {Http, HTTP_PROVIDERS} from 'angular2/http';
@ -58,7 +58,7 @@ function mergeOptions(defaultOpts, providedOpts, method, url): RequestOptions {
* ``` * ```
* *
* *
* #Example * ### Example
* *
* ``` * ```
* http.get('people.json').observer({next: (value) => this.people = people}); * http.get('people.json').observer({next: (value) => this.people = people});
@ -68,7 +68,7 @@ function mergeOptions(defaultOpts, providedOpts, method, url): RequestOptions {
* {@link XHRBackend} in this case), which could be mocked with dependency injection by replacing * {@link XHRBackend} in this case), which could be mocked with dependency injection by replacing
* the {@link XHRBackend} provider, as in the following example: * the {@link XHRBackend} provider, as in the following example:
* *
* #Example * ### Example
* *
* ```typescript * ```typescript
* import {MockBackend, BaseRequestOptions, Http} from 'angular2/http'; * import {MockBackend, BaseRequestOptions, Http} from 'angular2/http';

View File

@ -12,7 +12,7 @@ import {isJsObject} from './http_utils';
* usually instantiated by end-users, it is the primary object interacted with when it comes time to * usually instantiated by end-users, it is the primary object interacted with when it comes time to
* add data to a view. * add data to a view.
* *
* #Example * ### Example
* *
* ``` * ```
* http.request('my-friends.txt').subscribe(response => this.friends = response.text()); * http.request('my-friends.txt').subscribe(response => this.friends = response.text());

View File

@ -12,7 +12,7 @@ import {EventListener, History, Location} from 'angular2/src/core/facade/browser
* For instance, if you call `location.go('/foo')`, the browser's URL will become * For instance, if you call `location.go('/foo')`, the browser's URL will become
* `example.com#/foo`. * `example.com#/foo`.
* *
* ## Example * ### Example
* *
* ``` * ```
* import {Component, View} from 'angular2/angular2'; * import {Component, View} from 'angular2/angular2';

View File

@ -12,7 +12,7 @@ import {Url} from './url_parser';
* *
* You can inject `RouteParams` into the constructor of a component to use it. * You can inject `RouteParams` into the constructor of a component to use it.
* *
* ## Example * ### Example
* *
* ``` * ```
* import {bootstrap, Component} from 'angular2/angular2'; * import {bootstrap, Component} from 'angular2/angular2';
@ -48,7 +48,7 @@ export class RouteParams {
* `Instruction`s can be created using {@link Router#generate}, and can be used to * `Instruction`s can be created using {@link Router#generate}, and can be used to
* perform route changes with {@link Router#navigateByInstruction}. * perform route changes with {@link Router#navigateByInstruction}.
* *
* ## Example * ### Example
* *
* ``` * ```
* import {bootstrap, Component} from 'angular2/angular2'; * import {bootstrap, Component} from 'angular2/angular2';

View File

@ -21,7 +21,7 @@ var __ignore_me = global;
* If `onActivate` returns a promise, the route change will wait until the promise settles to * If `onActivate` returns a promise, the route change will wait until the promise settles to
* instantiate and activate child components. * instantiate and activate child components.
* *
* ## Example * ### Example
* ``` * ```
* import {Component} from 'angular2/angular2'; * import {Component} from 'angular2/angular2';
* import {OnActivate, ComponentInstruction} from 'angular2/router'; * import {OnActivate, ComponentInstruction} from 'angular2/router';
@ -52,7 +52,7 @@ export interface OnActivate {
* representing the current route being navigated to, and the second parameter representing the * representing the current route being navigated to, and the second parameter representing the
* previous route or `null`. * previous route or `null`.
* *
* ## Example * ### Example
* ``` * ```
* import {Component} from 'angular2/angular2'; * import {Component} from 'angular2/angular2';
* import {CanReuse, OnReuse, ComponentInstruction} from 'angular2/router'; * import {CanReuse, OnReuse, ComponentInstruction} from 'angular2/router';
@ -86,7 +86,7 @@ export interface OnReuse {
* *
* If `onDeactivate` returns a promise, the route change will wait until the promise settles. * If `onDeactivate` returns a promise, the route change will wait until the promise settles.
* *
* ## Example * ### Example
* ``` * ```
* import {Component} from 'angular2/angular2'; * import {Component} from 'angular2/angular2';
* import {OnDeactivate, ComponentInstruction} from 'angular2/router'; * import {OnDeactivate, ComponentInstruction} from 'angular2/router';
@ -121,7 +121,7 @@ export interface OnDeactivate {
* *
* If `canReuse` throws or rejects, the navigation will be cancelled. * If `canReuse` throws or rejects, the navigation will be cancelled.
* *
* ## Example * ### Example
* ``` * ```
* import {Component} from 'angular2/angular2'; * import {Component} from 'angular2/angular2';
* import {CanReuse, OnReuse, ComponentInstruction} from 'angular2/router'; * import {CanReuse, OnReuse, ComponentInstruction} from 'angular2/router';
@ -159,7 +159,7 @@ export interface CanReuse {
* *
* If `canDeactivate` throws or rejects, the navigation is also cancelled. * If `canDeactivate` throws or rejects, the navigation is also cancelled.
* *
* ## Example * ### Example
* ``` * ```
* import {Component} from 'angular2/angular2'; * import {Component} from 'angular2/angular2';
* import {CanDeactivate, ComponentInstruction} from 'angular2/router'; * import {CanDeactivate, ComponentInstruction} from 'angular2/router';

View File

@ -33,7 +33,7 @@ export {
* If `CanActivate` returns or resolves to `true`, navigation continues, the component is * If `CanActivate` returns or resolves to `true`, navigation continues, the component is
* instantiated, and the {@link OnActivate} hook of that component is called if implemented. * instantiated, and the {@link OnActivate} hook of that component is called if implemented.
* *
* ## Example * ### Example
* ``` * ```
* import {Component} from 'angular2/angular2'; * import {Component} from 'angular2/angular2';
* import {CanActivate} from 'angular2/router'; * import {CanActivate} from 'angular2/router';

View File

@ -13,7 +13,7 @@ import {OpaqueToken, Injectable, Optional, Inject} from 'angular2/angular2';
* representing the URL prefix that should be preserved when generating and recognizing * representing the URL prefix that should be preserved when generating and recognizing
* URLs. * URLs.
* *
* ## Example * ### Example
* *
* ``` * ```
* import {Component} from 'angular2/angular2'; * import {Component} from 'angular2/angular2';
@ -52,7 +52,7 @@ export const APP_BASE_HREF: OpaqueToken = CONST_EXPR(new OpaqueToken('appBaseHre
* - `my/app/user/123` **is not** normalized * - `my/app/user/123` **is not** normalized
* - `/my/app/user/123/` **is not** normalized * - `/my/app/user/123/` **is not** normalized
* *
* ## Example * ### Example
* *
* ``` * ```
* import {Component} from 'angular2/angular2'; * import {Component} from 'angular2/angular2';

View File

@ -20,7 +20,7 @@ import {LocationStrategy, normalizeQueryParams} from './location_strategy';
* `location.go('/foo')`, the browser's URL will become * `location.go('/foo')`, the browser's URL will become
* `example.com/my/app/foo`. * `example.com/my/app/foo`.
* *
* ## Example * ### Example
* *
* ``` * ```
* import {Component, provide} from 'angular2/angular2'; * import {Component, provide} from 'angular2/angular2';

View File

@ -22,7 +22,7 @@ export class RouteConfig {
* - `data` is an optional property of any type representing arbitrary route metadata for the given * - `data` is an optional property of any type representing arbitrary route metadata for the given
* route. It is injectable via the {@link ROUTE_DATA} token. * route. It is injectable via the {@link ROUTE_DATA} token.
* *
* ## Example * ### Example
* ``` * ```
* import {RouteConfig} from 'angular2/router'; * import {RouteConfig} from 'angular2/router';
* *
@ -62,7 +62,7 @@ export class Route implements RouteDefinition {
* - `data` is an optional property of any type representing arbitrary route metadata for the given * - `data` is an optional property of any type representing arbitrary route metadata for the given
* route. It is injectable via the {@link ROUTE_DATA} token. * route. It is injectable via the {@link ROUTE_DATA} token.
* *
* ## Example * ### Example
* ``` * ```
* import {RouteConfig, AuxRoute} from 'angular2/router'; * import {RouteConfig, AuxRoute} from 'angular2/router';
* *
@ -99,7 +99,7 @@ export class AuxRoute implements RouteDefinition {
* - `data` is an optional property of any type representing arbitrary route metadata for the given * - `data` is an optional property of any type representing arbitrary route metadata for the given
* route. It is injectable via the {@link ROUTE_DATA} token. * route. It is injectable via the {@link ROUTE_DATA} token.
* *
* ## Example * ### Example
* ``` * ```
* import {RouteConfig} from 'angular2/router'; * import {RouteConfig} from 'angular2/router';
* *
@ -131,7 +131,7 @@ export class AsyncRoute implements RouteDefinition {
* - `path` is a string that uses the route matcher DSL. * - `path` is a string that uses the route matcher DSL.
* - `redirectTo` is a string representing the new URL to be matched against. * - `redirectTo` is a string representing the new URL to be matched against.
* *
* ## Example * ### Example
* ``` * ```
* import {RouteConfig} from 'angular2/router'; * import {RouteConfig} from 'angular2/router';
* *

View File

@ -141,7 +141,7 @@ export class Router {
/** /**
* Dynamically update the routing configuration and trigger a navigation. * Dynamically update the routing configuration and trigger a navigation.
* *
* # Usage *##Usage
* *
* ``` * ```
* router.config([ * router.config([
@ -160,7 +160,7 @@ export class Router {
* Navigate based on the provided Route Link DSL. It's preferred to navigate with this method * Navigate based on the provided Route Link DSL. It's preferred to navigate with this method
* over `navigateByUrl`. * over `navigateByUrl`.
* *
* # Usage *##Usage
* *
* This method takes an array representing the Route Link DSL: * This method takes an array representing the Route Link DSL:
* ``` * ```

View File

@ -51,7 +51,7 @@ import {compilerProviders} from 'angular2/src/core/compiler/compiler';
* *
* See {@link PlatformRef} for details on the Angular platform. * See {@link PlatformRef} for details on the Angular platform.
* *
* # Without specified providers *##Without specified providers
* *
* If no providers are specified, `platform`'s behavior depends on whether an existing * If no providers are specified, `platform`'s behavior depends on whether an existing
* platform exists: * platform exists:
@ -62,7 +62,7 @@ import {compilerProviders} from 'angular2/src/core/compiler/compiler';
* was created with). This is a convenience feature, allowing for multiple applications * was created with). This is a convenience feature, allowing for multiple applications
* to be loaded into the same platform without awareness of each other. * to be loaded into the same platform without awareness of each other.
* *
* # With specified providers *##With specified providers
* *
* It is also possible to specify providers to be made in the new platform. These providers * It is also possible to specify providers to be made in the new platform. These providers
* will be shared between all applications on the page. For example, an abstraction for * will be shared between all applications on the page. For example, an abstraction for
@ -73,7 +73,7 @@ import {compilerProviders} from 'angular2/src/core/compiler/compiler';
* them if a platform did not exist already. If it did exist, however, an error will be * them if a platform did not exist already. If it did exist, however, an error will be
* thrown. * thrown.
* *
* # For Web Worker Appplications *##For Web Worker Appplications
* *
* This version of `platform` initializes Angular for use with applications * This version of `platform` initializes Angular for use with applications
* that do not directly touch the DOM, such as applications which run in a * that do not directly touch the DOM, such as applications which run in a

View File

@ -76,7 +76,7 @@ var upgradeCount: number = 0;
* 9. The new application is running in Angular v2 zone, and therefore it no longer needs calls to * 9. The new application is running in Angular v2 zone, and therefore it no longer needs calls to
* `$apply()`. * `$apply()`.
* *
* ## Example * ### Example
* *
* ``` * ```
* var adapter = new UpgradeAdapter(); * var adapter = new UpgradeAdapter();
@ -143,7 +143,7 @@ export class UpgradeAdapter {
* - Event: `<comp (close)="doSomething()">` * - Event: `<comp (close)="doSomething()">`
* - Content projection: yes * - Content projection: yes
* *
* ## Example * ### Example
* *
* ``` * ```
* var adapter = new UpgradeAdapter(); * var adapter = new UpgradeAdapter();
@ -215,7 +215,7 @@ export class UpgradeAdapter {
* - `transclude`: supported. * - `transclude`: supported.
* *
* *
* ## Example * ### Example
* *
* ``` * ```
* var adapter = new UpgradeAdapter(); * var adapter = new UpgradeAdapter();
@ -260,7 +260,7 @@ export class UpgradeAdapter {
* [`bootstrap`](https://docs.angularjs.org/api/ng/function/angular.bootstrap) method. Unlike * [`bootstrap`](https://docs.angularjs.org/api/ng/function/angular.bootstrap) method. Unlike
* AngularJS v1, this bootstrap is asynchronous. * AngularJS v1, this bootstrap is asynchronous.
* *
* ## Example * ### Example
* *
* ``` * ```
* var adapter = new UpgradeAdapter(); * var adapter = new UpgradeAdapter();
@ -374,7 +374,7 @@ export class UpgradeAdapter {
* for this reason we provide an application global way of registering providers which is * for this reason we provide an application global way of registering providers which is
* consistent with single global injection in AngularJS v1. * consistent with single global injection in AngularJS v1.
* *
* ## Example * ### Example
* *
* ``` * ```
* class Greeter { * class Greeter {
@ -409,7 +409,7 @@ export class UpgradeAdapter {
* Allows AngularJS v1 service to be accessible from Angular v2. * Allows AngularJS v1 service to be accessible from Angular v2.
* *
* *
* ## Example * ### Example
* *
* ``` * ```
* class Login { ... } * class Login { ... }
@ -449,7 +449,7 @@ export class UpgradeAdapter {
* Allows Angular v2 service to be accessible from AngularJS v1. * Allows Angular v2 service to be accessible from AngularJS v1.
* *
* *
* ## Example * ### Example
* *
* ``` * ```
* class Example { * class Example {