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
@@ -72,7 +72,7 @@ export function applicationDomBindings(): Array<Type | Provider | any[]> {
*
* 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
* 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
* 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
* 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
* thrown.
*
* # DOM Applications
*##DOM Applications
*
* This version of `platform` initializes Angular to run in the UI thread, with direct
* 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.
*
*
* # API
*##API
* - `appComponentType`: The root component which should act as the application. This is
* a reference to a `Type` which is annotated with `@Component(...)`.
* - `componentInjectableBindings`: An additional set of providers that can be added to the
+8 -8
View File
@@ -159,20 +159,20 @@ export abstract class PlatformRef {
/**
* 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,
* renderer, and other framework components. An application hosts one or more
* root components, which can be initialized via `ApplicationRef.bootstrap()`.
*
* # Application Bindings
*##Application Bindings
*
* Angular applications require numerous providers to be properly instantiated.
* When using `application()` to create a new app on the page, these providers
* must be provided. Fortunately, there are helper functions to configure
* typical providers, as shown in the example below.
*
* # Example
* ### Example
* ```
* var myAppBindings = [MyAppService];
*
@@ -180,7 +180,7 @@ export abstract class PlatformRef {
* .application([applicationCommonBindings(), applicationDomBindings(), myAppBindings])
* .bootstrap(MyTopLevelComponent);
* ```
* # See Also
*##See Also
*
* 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
* application running in a web worker.
*
* # Usage
*##Usage
*
* `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
@@ -281,19 +281,19 @@ export abstract class ApplicationRef {
/**
* 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
* specified application component onto DOM elements identified by the [componentType]'s
* 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`
* parameter. These providers will only apply for the root component being added and any
* child components under it.
*
* # Example
* ### Example
* ```
* var app = platform.application([applicationCommonBindings(), applicationDomBindings()];
* app.bootstrap(FirstRootComponent);
@@ -44,7 +44,7 @@ export class IterableDiffers {
* 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.
*
* # Example
* ### Example
*
* ```
* @Component({
@@ -44,7 +44,7 @@ export class KeyValueDiffers {
* 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.
*
* # Example
* ### Example
*
* ```
* @Component({
@@ -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 items are reordered, their respective templates are reordered in the DOM.
*
* # Example
* ### Example
*
* ```
* <ul>
@@ -33,7 +33,7 @@ import {isPresent, isBlank} from 'angular2/src/core/facade/lang';
* </ul>
* ```
*
* # Syntax
*##Syntax
*
* - `<li *ng-for="#item of items; #i = index">...</li>`
* - `<li template="ng-for #item of items; #i = index">...</li>`
@@ -18,7 +18,7 @@ import {isBlank} from 'angular2/src/core/facade/lang';
* </div>
* ```
*
* # Syntax
*##Syntax
*
* - `<div *ng-if="condition">...</div>`
* - `<div template="ng-if condition">...</div>`
@@ -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
* 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]="styleExp"></div>` - here the `styleExp` must evaluate to an object
@@ -29,7 +29,7 @@ export class SwitchView {
* evaluated. If a matching expression is not found via a when attribute then an element with the
* default attribute is displayed.
*
* # Example:
* ### Example
*
* ```
* <ANY [ng-switch]="expression">
+1 -1
View File
@@ -49,7 +49,7 @@ export class Observable {
/**
* Use by directives and components to emit custom Events.
*
* ## Examples
* ### Examples
*
* In the following example, `Zippy` alternatively emits `open` and `close` events when its
* title gets clicked:
@@ -17,7 +17,7 @@ class _ArrayLogger {
* intercept error handling,
* write a custom exception handler that replaces this default as appropriate for your app.
*
* # Example
* ### Example
*
* ```javascript
*
+1 -1
View File
@@ -47,7 +47,7 @@ import {CONST_EXPR, Type} from './facade/lang';
/**
* Shorthand set of providers used for building Angular forms.
*
* ### Example:
* ### Example
*
* ```typescript
* bootstrap(MyApp, [FORM_PROVIDERS]);
@@ -38,7 +38,7 @@ export {NgControlStatus} from './directives/ng_control_status';
*
* This is a shorthand for importing them each individually.
*
* ### Example:
* ### Example
*
* ```typescript
* @Component({
@@ -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.
*
* # Example
* ### Example
* ```
* <input type="checkbox" [ng-control]="rememberLogin">
* ```
@@ -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
* {@link NgModel}, {@link NgFormControl}, and {@link NgControlName} directives.
*
* # Example
* ### Example
* ```
* <input type="text" [(ng-model)]="searchQuery">
* ```
@@ -17,7 +17,7 @@ const controlGroupBinding =
*
* 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.
* We can work with each group separately: check its validity, get its value, listen to its changes.
@@ -21,7 +21,7 @@ const controlNameBinding =
*
* 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.
* We can work with each control separately: check its validity, get its value, listen to its
@@ -22,19 +22,19 @@ const formDirectiveProvider =
* If `NgForm` is bound in a component, `<form>` elements in that component will be
* upgraded to use the Angular form system.
*
* # Typical Use
*##Typical Use
*
* Include `FORM_DIRECTIVES` in the `directives` section of a {@link View} annotation
* to use `NgForm` and its associated controls.
*
* # Structure
*##Structure
*
* 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
* or `ControlArray`s. This hierarchy is reflected in the form's `value`, a
* JSON object that mirrors the form structure.
*
* # Submission
*##Submission
*
* The `ng-submit` event signals when the user triggers a form submission.
*
@@ -42,7 +42,7 @@ const formControlBinding =
* }
* ```
*
* # ng-model
*##ng-model
*
* We can also use `ng-model` to bind a domain model to the form.
*
@@ -16,7 +16,7 @@ const formControlBinding =
/**
* Binds a domain model to a form control.
*
* # Usage
*##Usage
*
* `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
@@ -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
* {@link NgModel}, {@link NgFormControl}, and {@link NgControlName} directives.
*
* # Example
* ### Example
* ```
* <input type="number" [(ng-model)]="age">
* ```
@@ -14,7 +14,7 @@ const SELECT_VALUE_ACCESSOR = CONST_EXPR(new Provider(
/**
* Marks `<option>` as dynamic, so Angular can be notified when options change.
*
* #Example:
* ### Example
*
* ```
* <select ng-control="city">
@@ -7,7 +7,7 @@ import * as modelModule from './model';
/**
* Creates a form object from a user-specified configuration.
*
* # Example
* ### Example
*
* ```
* import {Component, bootstrap} from 'angular2/angular2';
+3 -3
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 {
/** @internal */
@@ -145,7 +145,7 @@ export class AbstractControl {
* `Control` is one of the three fundamental building blocks used to define forms in Angular, along
* with {@link ControlGroup} and {@link ControlArray}.
*
* # Usage
*##Usage
*
* 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
@@ -287,7 +287,7 @@ export class ControlGroup extends AbstractControl {
* along with {@link Control} and {@link ControlGroup}. {@link ControlGroup} can also contain
* 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
* in `ControlArray` itself. These methods ensure the controls are properly tracked in the
@@ -10,7 +10,7 @@ export const NG_VALIDATORS: OpaqueToken = CONST_EXPR(new OpaqueToken("NgValidato
/**
* Provides a set of validators used by form controls.
*
* # Example
* ### Example
*
* ```
* var loginControl = new Control("", Validators.required)
@@ -15,7 +15,7 @@ import {wtfLeave, wtfCreateScope, WtfScopeFn} from '../profile/profile';
*
* 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
* invokes
@@ -107,7 +107,7 @@ export abstract class DynamicComponentLoader {
* Returns a promise for the {@link ComponentRef} representing the newly created Component.
*
*
* ## Example
* ### Example
*
* ```
* @ng.Component({
@@ -167,7 +167,7 @@ export abstract class DynamicComponentLoader {
* Returns a promise for the {@link ComponentRef} representing the newly created Component.
*
*
* ## Example
* ### Example
*
* ```
* @ng.Component({
@@ -221,7 +221,7 @@ export abstract class DynamicComponentLoader {
* Returns a promise for the {@link ComponentRef} representing the newly created Component.
*
*
* ## Example
* ### Example
*
* ```
* @ng.Component({
@@ -76,7 +76,7 @@ export abstract class AppViewManager {
* Use {@link AppViewManager#destroyRootHostView} to destroy the created Component and it's Host
* View.
*
* ## Example
* ### Example
*
* ```
* @ng.Component({
+2 -2
View File
@@ -43,7 +43,7 @@ export interface HostViewRef {
* removing nested Views via a {@link ViewContainer}. Each View can contain many View Containers.
* <!-- /TODO -->
*
* ## Example
* ### Example
*
* Given this template...
*
@@ -139,7 +139,7 @@ export class ViewRef_ extends ViewRef {
* {@link Compiler#compileInHost} API.
*
*
* ## Example
* ### Example
*
* Given this template:
*
+20 -20
View File
@@ -107,7 +107,7 @@ export interface ViewDecorator extends TypeDecorator {
/**
* {@link DirectiveMetadata} factory for creating annotations, decorators or DSL.
*
* ## Example as TypeScript Decorator
* ### Example as TypeScript Decorator
*
* ```
* 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
@@ -132,7 +132,7 @@ export interface ViewDecorator extends TypeDecorator {
* })
* ```
*
* ## Example as ES5 annotation
* ### Example as ES5 annotation
*
* ```
* var MyDirective = function() {
@@ -176,7 +176,7 @@ export interface DirectiveFactory {
/**
* {@link ComponentMetadata} factory for creating annotations, decorators or DSL.
*
* ## Example as TypeScript Decorator
* ### Example as TypeScript Decorator
*
* ```
* import {Component} from "angular2/angular2";
@@ -189,7 +189,7 @@ export interface DirectiveFactory {
* }
* ```
*
* ## Example as ES5 DSL
* ### Example as ES5 DSL
*
* ```
* var MyComponent = ng
@@ -201,7 +201,7 @@ export interface DirectiveFactory {
* })
* ```
*
* ## Example as ES5 annotation
* ### Example as ES5 annotation
*
* ```
* var MyComponent = function() {
@@ -268,7 +268,7 @@ export interface ComponentFactory {
/**
* {@link ViewMetadata} factory for creating annotations, decorators or DSL.
*
* ## Example as TypeScript Decorator
* ### Example as TypeScript Decorator
*
* ```
* import {Component, View} from "angular2/angular2";
@@ -282,7 +282,7 @@ export interface ComponentFactory {
* }
* ```
*
* ## Example as ES5 DSL
* ### Example as ES5 DSL
*
* ```
* var MyComponent = ng
@@ -295,7 +295,7 @@ export interface ComponentFactory {
* })
* ```
*
* ## Example as ES5 annotation
* ### Example as ES5 annotation
*
* ```
* var MyComponent = function() {
@@ -332,7 +332,7 @@ export interface ViewFactory {
/**
* {@link AttributeMetadata} factory for creating annotations, decorators or DSL.
*
* ## Example as TypeScript Decorator
* ### Example as TypeScript Decorator
*
* ```
* import {Attribute, Component} from "angular2/angular2";
@@ -345,7 +345,7 @@ export interface ViewFactory {
* }
* ```
*
* ## Example as ES5 DSL
* ### Example as ES5 DSL
*
* ```
* var MyComponent = ng
@@ -357,7 +357,7 @@ export interface ViewFactory {
* })
* ```
*
* ## Example as ES5 annotation
* ### Example as ES5 annotation
*
* ```
* var MyComponent = function(title) {
@@ -449,7 +449,7 @@ export interface ViewChildFactory {
/**
* {@link PipeMetadata} factory for creating decorators.
*
* ## Example as TypeScript Decorator
* ### Example as TypeScript Decorator
*
* ```
* 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
* called by the change detection at defined points in time during the life of the component.
*
* ## Example
* ### Example
*
* ```
* @Component({
@@ -613,7 +613,7 @@ export var Component: ComponentFactory =
* {@link DirectiveMetadata} directives only
* - `bindingPropagation: BindingPropagation` to control change detection in a more granular way.
*
* ## Example
* ### Example
*
* The following example demonstrates how dependency injection resolves constructor arguments in
* practice.
@@ -782,7 +782,7 @@ export var Component: ComponentFactory =
* If none can be
* 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.
*
@@ -870,7 +870,7 @@ export var Component: ComponentFactory =
* 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.
*
* ## Example
* ### Example
*
* 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}.
*
* ## Example
* ### Example
*
* ```
* @Component({
@@ -975,7 +975,7 @@ export var View: ViewFactory =
*
* For details on the `@Component` annotation, see {@link ComponentMetadata}.
*
* ## Example
* ### Example
*
* ```
* @Component({
@@ -1242,7 +1242,7 @@ export var ViewQuery: QueryFactory = makeParamDecorator(ViewQueryMetadata);
/**
* Declare reusable pipe function.
*
* ## Example
* ### Example
*
* ```
* @Pipe({
+1 -1
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.
*
* ## Example
* ### Example
*
* Suppose we have an `<input>` element and want to know its `type`.
*
@@ -67,7 +67,7 @@ import {ViewEncapsulation} from 'angular2/src/core/metadata/view';
* {@link DirectiveMetadata} directives only
* - `bindingPropagation: BindingPropagation` to control change detection in a more granular way.
*
* ## Example
* ### Example
*
* The following example demonstrates how dependency injection resolves constructor arguments in
* practice.
@@ -236,7 +236,7 @@ import {ViewEncapsulation} from 'angular2/src/core/metadata/view';
* If none can be
* 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.
*
@@ -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
* 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.
*
@@ -399,7 +399,7 @@ export class DirectiveMetadata extends InjectableMetadata {
* - `selector1, selector2`: select if either `selector1` or `selector2` matches.
*
*
* ## Example
* ### Example
*
* 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
* called by the change detection at defined points in time during the life of the component.
*
* ## Example
* ### Example
*
* ```
* @Component({
@@ -948,7 +948,7 @@ export class ComponentMetadata extends DirectiveMetadata {
/**
* Declare reusable pipe function.
*
* ## Example
* ### Example
*
* ```
* @Pipe({
+2 -2
View File
@@ -44,7 +44,7 @@ export var VIEW_ENCAPSULATION_VALUES =
*
* For details on the `@Component` annotation, see {@link ComponentMetadata}.
*
* ## Example
* ### Example
*
* ```
* @Component({
@@ -96,7 +96,7 @@ export class ViewMetadata {
*
* Directives must be listed explicitly to provide proper component encapsulation.
*
* ## Example
* ### Example
*
* ```javascript
* @Component({
@@ -40,7 +40,7 @@ var _observableStrategy = new ObservableStrategy();
* emitted.
* 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
* updates the view with the current time.
*
+2 -2
View File
@@ -26,7 +26,7 @@ var defaultLocale: string = 'en-US';
*
* Formats a date value to a string based on the requested format.
*
* # Usage
*##Usage
*
* 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.
*
* # Examples
* ### Examples
*
* Assuming `dateObj` is (year: 2015, month: 6, day: 15, hour: 21, minute: 43, second: 11)
* in the _local_ time and locale is 'en-US':
+1 -1
View File
@@ -6,7 +6,7 @@ import {Pipe} from 'angular2/src/core/metadata';
/**
* Implements json transforms to any object.
*
* # Example
* ### Example
*
* In this example we transform the user object to json.
*
@@ -8,7 +8,7 @@ import {InvalidPipeArgumentException} from './invalid_pipe_argument_exception';
/**
* Implements lowercase transforms to text.
*
* # Example
* ### Example
*
* In this example we transform the user text lowercase.
*
@@ -62,7 +62,7 @@ export class NumberPipe {
* Formats a number as local text. i.e. group sizing and separator and other locale-specific
* configurations are based on the active locale.
*
* # Usage
*##Usage
*
* expression | number[:digitInfo]
*
@@ -77,7 +77,7 @@ export class NumberPipe {
* For more information on the acceptable range for each of these numbers and other
* details see your native internationalization library.
*
* # Examples
* ### Examples
*
* {{ 123 | number }} // output is 123
* {{ 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.
*
* # Usage
*##Usage
*
* expression | percent[:digitInfo]
*
@@ -121,7 +121,7 @@ export class PercentPipe extends NumberPipe implements PipeTransform {
*
* Formats a number as local currency.
*
* # Usage
*##Usage
*
* expression | currency[:currencyCode[:symbolDisplay[:digitInfo]]]
*
@@ -16,7 +16,7 @@ import {Pipe} from '../metadata';
*
* The ending index of the subset to return is specified by the optional `end` parameter.
*
* # Usage
*##Usage
*
* 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
* the elements are being returned.
*
* # Examples
* ### Examples
*
* ## List Example
*
@@ -7,7 +7,7 @@ import {InvalidPipeArgumentException} from './invalid_pipe_argument_exception';
/**
* Implements uppercase transforms to text.
*
* # Example
* ### Example
*
* In this example we transform the user text uppercase.
*
+2 -2
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({
@@ -187,7 +187,7 @@ function applyParams(fnOrArray: (Function | any[]), key: string): Function {
* }
* ```
*
* ## Example with inheritance
* ### Example with inheritance
*
* ```
* var Shape = ng.Class({