From be3e7db5db23424d9134ea0eda32c0da5bea6779 Mon Sep 17 00:00:00 2001 From: Naomi Black Date: Mon, 19 Oct 2015 15:37:32 +0100 Subject: [PATCH] docs(chore): make styles consistent for API doc headings Closes #4816 --- modules/angular1_router/src/ng_outlet.ts | 2 +- modules/angular2/router.ts | 6 +-- .../angular2/src/core/application_common.ts | 8 ++-- modules/angular2/src/core/application_ref.ts | 16 ++++---- .../differs/iterable_differs.ts | 2 +- .../differs/keyvalue_differs.ts | 2 +- .../angular2/src/core/directives/ng_for.ts | 4 +- modules/angular2/src/core/directives/ng_if.ts | 2 +- .../angular2/src/core/directives/ng_style.ts | 2 +- .../angular2/src/core/directives/ng_switch.ts | 2 +- modules/angular2/src/core/facade/async.ts | 2 +- .../src/core/facade/exception_handler.ts | 2 +- modules/angular2/src/core/forms.ts | 2 +- modules/angular2/src/core/forms/directives.ts | 2 +- .../directives/checkbox_value_accessor.ts | 2 +- .../directives/default_value_accessor.ts | 2 +- .../core/forms/directives/ng_control_group.ts | 2 +- .../core/forms/directives/ng_control_name.ts | 2 +- .../src/core/forms/directives/ng_form.ts | 6 +-- .../core/forms/directives/ng_form_control.ts | 2 +- .../src/core/forms/directives/ng_model.ts | 2 +- .../forms/directives/number_value_accessor.ts | 2 +- .../select_control_value_accessor.ts | 2 +- .../angular2/src/core/forms/form_builder.ts | 2 +- modules/angular2/src/core/forms/model.ts | 6 +-- modules/angular2/src/core/forms/validators.ts | 2 +- .../src/core/life_cycle/life_cycle.ts | 2 +- .../core/linker/dynamic_component_loader.ts | 6 +-- .../angular2/src/core/linker/view_manager.ts | 2 +- modules/angular2/src/core/linker/view_ref.ts | 4 +- modules/angular2/src/core/metadata.ts | 40 +++++++++---------- modules/angular2/src/core/metadata/di.ts | 2 +- .../angular2/src/core/metadata/directives.ts | 12 +++--- modules/angular2/src/core/metadata/view.ts | 4 +- modules/angular2/src/core/pipes/async_pipe.ts | 2 +- modules/angular2/src/core/pipes/date_pipe.ts | 4 +- modules/angular2/src/core/pipes/json_pipe.ts | 2 +- .../angular2/src/core/pipes/lowercase_pipe.ts | 2 +- .../angular2/src/core/pipes/number_pipe.ts | 8 ++-- modules/angular2/src/core/pipes/slice_pipe.ts | 4 +- .../angular2/src/core/pipes/uppercase_pipe.ts | 2 +- modules/angular2/src/core/util/decorators.ts | 4 +- .../src/http/backends/mock_backend.ts | 6 +-- .../angular2/src/http/backends/xhr_backend.ts | 2 +- .../angular2/src/http/base_request_options.ts | 2 +- .../src/http/base_response_options.ts | 2 +- modules/angular2/src/http/http.ts | 6 +-- modules/angular2/src/http/static_response.ts | 2 +- .../src/router/hash_location_strategy.ts | 2 +- modules/angular2/src/router/instruction.ts | 4 +- modules/angular2/src/router/interfaces.ts | 10 ++--- .../src/router/lifecycle_annotations.ts | 2 +- modules/angular2/src/router/location.ts | 4 +- .../src/router/path_location_strategy.ts | 2 +- .../angular2/src/router/route_config_impl.ts | 8 ++-- modules/angular2/src/router/router.ts | 4 +- .../web_workers/worker/application_common.ts | 6 +-- modules/upgrade/src/upgrade_adapter.ts | 14 +++---- 58 files changed, 131 insertions(+), 131 deletions(-) diff --git a/modules/angular1_router/src/ng_outlet.ts b/modules/angular1_router/src/ng_outlet.ts index a01ff92de1..4e2774fbae 100644 --- a/modules/angular1_router/src/ng_outlet.ts +++ b/modules/angular1_router/src/ng_outlet.ts @@ -221,7 +221,7 @@ function ngOutletFillContentDirective($compile) { * ## Use * The directive uses a simple syntax: `ng-link="componentName({ param: paramValue })"` * - * ## Example + * ### Example * * ```js * angular.module('myApp', ['ngComponentRouter']) diff --git a/modules/angular2/router.ts b/modules/angular2/router.ts index 38b6f48dad..2522c3ac85 100644 --- a/modules/angular2/router.ts +++ b/modules/angular2/router.ts @@ -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 * application. * - * ## Example ([live demo](http://plnkr.co/edit/iRUP8B5OUbxCWQ3AcIDm)) + * ### Example ([live demo](http://plnkr.co/edit/iRUP8B5OUbxCWQ3AcIDm)) * * ``` * 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 * component. * - * ## Example ([live demo](http://plnkr.co/edit/iRUP8B5OUbxCWQ3AcIDm)) + * ### Example ([live demo](http://plnkr.co/edit/iRUP8B5OUbxCWQ3AcIDm)) * * ``` * 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. * - * ## Example ([live demo](http://plnkr.co/edit/iRUP8B5OUbxCWQ3AcIDm)) + * ### Example ([live demo](http://plnkr.co/edit/iRUP8B5OUbxCWQ3AcIDm)) * * ``` * import {Component} from 'angular2/angular2'; diff --git a/modules/angular2/src/core/application_common.ts b/modules/angular2/src/core/application_common.ts index 4a1bd02a4d..912a42f5a4 100644 --- a/modules/angular2/src/core/application_common.ts +++ b/modules/angular2/src/core/application_common.ts @@ -72,7 +72,7 @@ export function applicationDomBindings(): Array { * * 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 { * 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 { * 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): 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 diff --git a/modules/angular2/src/core/application_ref.ts b/modules/angular2/src/core/application_ref.ts index 30bb9ecbdb..c669ceaa56 100644 --- a/modules/angular2/src/core/application_ref.ts +++ b/modules/angular2/src/core/application_ref.ts @@ -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); diff --git a/modules/angular2/src/core/change_detection/differs/iterable_differs.ts b/modules/angular2/src/core/change_detection/differs/iterable_differs.ts index a2ed3d58de..4b69e414d1 100644 --- a/modules/angular2/src/core/change_detection/differs/iterable_differs.ts +++ b/modules/angular2/src/core/change_detection/differs/iterable_differs.ts @@ -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({ diff --git a/modules/angular2/src/core/change_detection/differs/keyvalue_differs.ts b/modules/angular2/src/core/change_detection/differs/keyvalue_differs.ts index e14e13fb9d..e1f6c28275 100644 --- a/modules/angular2/src/core/change_detection/differs/keyvalue_differs.ts +++ b/modules/angular2/src/core/change_detection/differs/keyvalue_differs.ts @@ -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({ diff --git a/modules/angular2/src/core/directives/ng_for.ts b/modules/angular2/src/core/directives/ng_for.ts index ebdbcb46d8..4cf0e8f343 100644 --- a/modules/angular2/src/core/directives/ng_for.ts +++ b/modules/angular2/src/core/directives/ng_for.ts @@ -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 * * ``` *
    @@ -33,7 +33,7 @@ import {isPresent, isBlank} from 'angular2/src/core/facade/lang'; *
* ``` * - * # Syntax + *##Syntax * * - `
  • ...
    • ` * - `
  • ...
    • ` diff --git a/modules/angular2/src/core/directives/ng_if.ts b/modules/angular2/src/core/directives/ng_if.ts index 405d390c6e..6f9b492721 100644 --- a/modules/angular2/src/core/directives/ng_if.ts +++ b/modules/angular2/src/core/directives/ng_if.ts @@ -18,7 +18,7 @@ import {isBlank} from 'angular2/src/core/facade/lang'; * * ``` * - * # Syntax + *##Syntax * * - `
    ...
    ` * - `
    ...
    ` diff --git a/modules/angular2/src/core/directives/ng_style.ts b/modules/angular2/src/core/directives/ng_style.ts index a807b3888f..cb9669f94b 100644 --- a/modules/angular2/src/core/directives/ng_style.ts +++ b/modules/angular2/src/core/directives/ng_style.ts @@ -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 * * - `
    ` * - `
    ` - here the `styleExp` must evaluate to an object diff --git a/modules/angular2/src/core/directives/ng_switch.ts b/modules/angular2/src/core/directives/ng_switch.ts index a8d3402143..53ff430eeb 100644 --- a/modules/angular2/src/core/directives/ng_switch.ts +++ b/modules/angular2/src/core/directives/ng_switch.ts @@ -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 * * ``` * diff --git a/modules/angular2/src/core/facade/async.ts b/modules/angular2/src/core/facade/async.ts index 5a7600d74c..98bc5627cb 100644 --- a/modules/angular2/src/core/facade/async.ts +++ b/modules/angular2/src/core/facade/async.ts @@ -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: diff --git a/modules/angular2/src/core/facade/exception_handler.ts b/modules/angular2/src/core/facade/exception_handler.ts index 5ab3a2a67f..e45fa81c8c 100644 --- a/modules/angular2/src/core/facade/exception_handler.ts +++ b/modules/angular2/src/core/facade/exception_handler.ts @@ -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 * diff --git a/modules/angular2/src/core/forms.ts b/modules/angular2/src/core/forms.ts index 65b4cf0be6..834a936de1 100644 --- a/modules/angular2/src/core/forms.ts +++ b/modules/angular2/src/core/forms.ts @@ -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]); diff --git a/modules/angular2/src/core/forms/directives.ts b/modules/angular2/src/core/forms/directives.ts index d8c9f1ee9e..78087181d7 100644 --- a/modules/angular2/src/core/forms/directives.ts +++ b/modules/angular2/src/core/forms/directives.ts @@ -38,7 +38,7 @@ export {NgControlStatus} from './directives/ng_control_status'; * * This is a shorthand for importing them each individually. * - * ### Example: + * ### Example * * ```typescript * @Component({ diff --git a/modules/angular2/src/core/forms/directives/checkbox_value_accessor.ts b/modules/angular2/src/core/forms/directives/checkbox_value_accessor.ts index 7a843b893c..7d6df78845 100644 --- a/modules/angular2/src/core/forms/directives/checkbox_value_accessor.ts +++ b/modules/angular2/src/core/forms/directives/checkbox_value_accessor.ts @@ -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 * ``` * * ``` diff --git a/modules/angular2/src/core/forms/directives/default_value_accessor.ts b/modules/angular2/src/core/forms/directives/default_value_accessor.ts index c7b0e3e804..7ba3cb4b2e 100644 --- a/modules/angular2/src/core/forms/directives/default_value_accessor.ts +++ b/modules/angular2/src/core/forms/directives/default_value_accessor.ts @@ -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 * ``` * * ``` diff --git a/modules/angular2/src/core/forms/directives/ng_control_group.ts b/modules/angular2/src/core/forms/directives/ng_control_group.ts index 8e787bb861..03c52a224a 100644 --- a/modules/angular2/src/core/forms/directives/ng_control_group.ts +++ b/modules/angular2/src/core/forms/directives/ng_control_group.ts @@ -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. diff --git a/modules/angular2/src/core/forms/directives/ng_control_name.ts b/modules/angular2/src/core/forms/directives/ng_control_name.ts index 8edd82999e..e9a0fe5814 100644 --- a/modules/angular2/src/core/forms/directives/ng_control_name.ts +++ b/modules/angular2/src/core/forms/directives/ng_control_name.ts @@ -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 diff --git a/modules/angular2/src/core/forms/directives/ng_form.ts b/modules/angular2/src/core/forms/directives/ng_form.ts index e7c13f02a3..0b68411c35 100644 --- a/modules/angular2/src/core/forms/directives/ng_form.ts +++ b/modules/angular2/src/core/forms/directives/ng_form.ts @@ -22,19 +22,19 @@ const formDirectiveProvider = * If `NgForm` is bound in a component, `
    ` 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. * diff --git a/modules/angular2/src/core/forms/directives/ng_form_control.ts b/modules/angular2/src/core/forms/directives/ng_form_control.ts index 156829e0f1..63fd201c4e 100644 --- a/modules/angular2/src/core/forms/directives/ng_form_control.ts +++ b/modules/angular2/src/core/forms/directives/ng_form_control.ts @@ -42,7 +42,7 @@ const formControlBinding = * } * ``` * - * # ng-model + *##ng-model * * We can also use `ng-model` to bind a domain model to the form. * diff --git a/modules/angular2/src/core/forms/directives/ng_model.ts b/modules/angular2/src/core/forms/directives/ng_model.ts index 937f62161e..ee342b5be3 100644 --- a/modules/angular2/src/core/forms/directives/ng_model.ts +++ b/modules/angular2/src/core/forms/directives/ng_model.ts @@ -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 diff --git a/modules/angular2/src/core/forms/directives/number_value_accessor.ts b/modules/angular2/src/core/forms/directives/number_value_accessor.ts index d308db4ac3..c574e9783e 100644 --- a/modules/angular2/src/core/forms/directives/number_value_accessor.ts +++ b/modules/angular2/src/core/forms/directives/number_value_accessor.ts @@ -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 * ``` * * ``` diff --git a/modules/angular2/src/core/forms/directives/select_control_value_accessor.ts b/modules/angular2/src/core/forms/directives/select_control_value_accessor.ts index fb4cee131a..de7eb63292 100644 --- a/modules/angular2/src/core/forms/directives/select_control_value_accessor.ts +++ b/modules/angular2/src/core/forms/directives/select_control_value_accessor.ts @@ -14,7 +14,7 @@ const SELECT_VALUE_ACCESSOR = CONST_EXPR(new Provider( /** * Marks `