X Tutup
Skip to content

Commit be3e7db

Browse files
naomiblacknaomiblack
committed
docs(chore): make styles consistent for API doc headings
Closes angular#4816
1 parent 2c98a0f commit be3e7db

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+131
-131
lines changed

‎modules/angular1_router/src/ng_outlet.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ function ngOutletFillContentDirective($compile) {
221221
* ## Use
222222
* The directive uses a simple syntax: `ng-link="componentName({ param: paramValue })"`
223223
*
224-
* ## Example
224+
* ### Example
225225
*
226226
* ```js
227227
* angular.module('myApp', ['ngComponentRouter'])

‎modules/angular2/router.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ import {BaseException} from 'angular2/src/core/facade/exceptions';
3737
* Token used to bind the component with the top-level {@link RouteConfig}s for the
3838
* application.
3939
*
40-
* ## Example ([live demo](http://plnkr.co/edit/iRUP8B5OUbxCWQ3AcIDm))
40+
* ### Example ([live demo](http://plnkr.co/edit/iRUP8B5OUbxCWQ3AcIDm))
4141
*
4242
* ```
4343
* import {Component} from 'angular2/angular2';
@@ -66,7 +66,7 @@ export const ROUTER_PRIMARY_COMPONENT: OpaqueToken =
6666
* {@link RouterLink}, add this to your `directives` array in the {@link View} decorator of your
6767
* component.
6868
*
69-
* ## Example ([live demo](http://plnkr.co/edit/iRUP8B5OUbxCWQ3AcIDm))
69+
* ### Example ([live demo](http://plnkr.co/edit/iRUP8B5OUbxCWQ3AcIDm))
7070
*
7171
* ```
7272
* import {Component} from 'angular2/angular2';
@@ -88,7 +88,7 @@ export const ROUTER_DIRECTIVES: any[] = CONST_EXPR([RouterOutlet, RouterLink]);
8888
/**
8989
* A list of {@link Provider}s. To use the router, you must add this to your application.
9090
*
91-
* ## Example ([live demo](http://plnkr.co/edit/iRUP8B5OUbxCWQ3AcIDm))
91+
* ### Example ([live demo](http://plnkr.co/edit/iRUP8B5OUbxCWQ3AcIDm))
9292
*
9393
* ```
9494
* import {Component} from 'angular2/angular2';

‎modules/angular2/src/core/application_common.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ export function applicationDomBindings(): Array<Type | Provider | any[]> {
7272
*
7373
* See {@link PlatformRef} for details on the Angular platform.
7474
*
75-
* # Without specified providers
75+
*##Without specified providers
7676
*
7777
* If no providers are specified, `platform`'s behavior depends on whether an existing
7878
* platform exists:
@@ -83,7 +83,7 @@ export function applicationDomBindings(): Array<Type | Provider | any[]> {
8383
* was created with). This is a convenience feature, allowing for multiple applications
8484
* to be loaded into the same platform without awareness of each other.
8585
*
86-
* # With specified providers
86+
*##With specified providers
8787
*
8888
* It is also possible to specify providers to be made in the new platform. These providers
8989
* 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[]> {
9494
* them if a platform did not exist already. If it did exist, however, an error will be
9595
* thrown.
9696
*
97-
* # DOM Applications
97+
*##DOM Applications
9898
*
9999
* This version of `platform` initializes Angular to run in the UI thread, with direct
100100
* DOM access. Web-worker applications should call `platform` from
@@ -208,7 +208,7 @@ export function platform(bindings?: Array<Type | Provider | any[]>): PlatformRef
208208
* to that application.
209209
*
210210
*
211-
* # API
211+
*##API
212212
* - `appComponentType`: The root component which should act as the application. This is
213213
* a reference to a `Type` which is annotated with `@Component(...)`.
214214
* - `componentInjectableBindings`: An additional set of providers that can be added to the

‎modules/angular2/src/core/application_ref.ts‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -159,28 +159,28 @@ export abstract class PlatformRef {
159159
/**
160160
* Instantiate a new Angular application on the page.
161161
*
162-
* # What is an application?
162+
*##What is an application?
163163
*
164164
* Each Angular application has its own zone, change detection, compiler,
165165
* renderer, and other framework components. An application hosts one or more
166166
* root components, which can be initialized via `ApplicationRef.bootstrap()`.
167167
*
168-
* # Application Bindings
168+
*##Application Bindings
169169
*
170170
* Angular applications require numerous providers to be properly instantiated.
171171
* When using `application()` to create a new app on the page, these providers
172172
* must be provided. Fortunately, there are helper functions to configure
173173
* typical providers, as shown in the example below.
174174
*
175-
* # Example
175+
* ### Example
176176
* ```
177177
* var myAppBindings = [MyAppService];
178178
*
179179
* platform()
180180
* .application([applicationCommonBindings(), applicationDomBindings(), myAppBindings])
181181
* .bootstrap(MyTopLevelComponent);
182182
* ```
183-
* # See Also
183+
*##See Also
184184
*
185185
* See the {@link bootstrap} documentation for more details.
186186
*/
@@ -191,7 +191,7 @@ export abstract class PlatformRef {
191191
* are only available asynchronously. One such use case is to initialize an
192192
* application running in a web worker.
193193
*
194-
* # Usage
194+
*##Usage
195195
*
196196
* `bindingFn` is a function that will be called in the new application's zone.
197197
* It should return a `Promise` to a list of providers to be used for the
@@ -281,19 +281,19 @@ export abstract class ApplicationRef {
281281
/**
282282
* Bootstrap a new component at the root level of the application.
283283
*
284-
* # Bootstrap process
284+
*##Bootstrap process
285285
*
286286
* When bootstrapping a new root component into an application, Angular mounts the
287287
* specified application component onto DOM elements identified by the [componentType]'s
288288
* selector and kicks off automatic change detection to finish initializing the component.
289289
*
290-
* # Optional Bindings
290+
*##Optional Bindings
291291
*
292292
* Bindings for the given component can optionally be overridden via the `providers`
293293
* parameter. These providers will only apply for the root component being added and any
294294
* child components under it.
295295
*
296-
* # Example
296+
* ### Example
297297
* ```
298298
* var app = platform.application([applicationCommonBindings(), applicationDomBindings()];
299299
* app.bootstrap(FirstRootComponent);

‎modules/angular2/src/core/change_detection/differs/iterable_differs.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export class IterableDiffers {
4444
* which will only be applied to the injector for this component and its children.
4545
* This step is all that's required to make a new {@link IterableDiffer} available.
4646
*
47-
* # Example
47+
* ### Example
4848
*
4949
* ```
5050
* @Component({

‎modules/angular2/src/core/change_detection/differs/keyvalue_differs.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export class KeyValueDiffers {
4444
* which will only be applied to the injector for this component and its children.
4545
* This step is all that's required to make a new {@link KeyValueDiffer} available.
4646
*
47-
* # Example
47+
* ### Example
4848
*
4949
* ```
5050
* @Component({

‎modules/angular2/src/core/directives/ng_for.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import {isPresent, isBlank} from 'angular2/src/core/facade/lang';
2323
* * When an item is removed, its template instance is removed from the DOM.
2424
* * When items are reordered, their respective templates are reordered in the DOM.
2525
*
26-
* # Example
26+
* ### Example
2727
*
2828
* ```
2929
* <ul>
@@ -33,7 +33,7 @@ import {isPresent, isBlank} from 'angular2/src/core/facade/lang';
3333
* </ul>
3434
* ```
3535
*
36-
* # Syntax
36+
*##Syntax
3737
*
3838
* - `<li *ng-for="#item of items; #i = index">...</li>`
3939
* - `<li template="ng-for #item of items; #i = index">...</li>`

‎modules/angular2/src/core/directives/ng_if.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import {isBlank} from 'angular2/src/core/facade/lang';
1818
* </div>
1919
* ```
2020
*
21-
* # Syntax
21+
*##Syntax
2222
*
2323
* - `<div *ng-if="condition">...</div>`
2424
* - `<div template="ng-if condition">...</div>`

‎modules/angular2/src/core/directives/ng_style.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import {isPresent, isBlank, print} from 'angular2/src/core/facade/lang';
1515
* corresponding element styles are updated based on changes to this object. Style names to update
1616
* are taken from the object's keys, and values - from the corresponding object's values.
1717
*
18-
* # Syntax
18+
*##Syntax
1919
*
2020
* - `<div [ng-style]="{'font-style': style}"></div>`
2121
* - `<div [ng-style]="styleExp"></div>` - here the `styleExp` must evaluate to an object

‎modules/angular2/src/core/directives/ng_switch.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export class SwitchView {
2929
* evaluated. If a matching expression is not found via a when attribute then an element with the
3030
* default attribute is displayed.
3131
*
32-
* # Example:
32+
* ### Example
3333
*
3434
* ```
3535
* <ANY [ng-switch]="expression">

0 commit comments

Comments
 (0)
X Tutup