honeymoose/angular-cn
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(common): remove h1s from API docs

Browse Source 
Only one h1 is allowed per document, and this is provided by the template.
So we cannot have any h1 tags (or `#` markdown shorthand) in any API docs.

Closes #16193
This commit is contained in:
Peter Bacon Darwin 2017-05-10 11:00:02 +01:00 committed by Pete Bacon Darwin
parent 56ccd5e6a1
commit 67dc970ce4
3 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/common/src/directives/ng_component_outlet.ts
View File

@ -49,7 +49,7 @@ import {ComponentFactoryResolver, ComponentRef, Directive, Injector, Input, NgMo
* ngModuleFactory: moduleFactory;"> * ngModuleFactory: moduleFactory;">
* </ng-container> * </ng-container>
* ``` * ```
* # Example * ## Example
* *
* {@example common/ngComponentOutlet/ts/module.ts region='SimpleExample'} * {@example common/ngComponentOutlet/ts/module.ts region='SimpleExample'}
* *

8
packages/common/src/directives/ng_if.ts
View File

@ -17,13 +17,13 @@ import {Directive, EmbeddedViewRef, Input, TemplateRef, ViewContainerRef} from '
* - `then` template is the inline template of `ngIf` unless bound to a different value. * - `then` template is the inline template of `ngIf` unless bound to a different value.
* - `else` template is blank unless it is bound. * - `else` template is blank unless it is bound.
* *
* # Most common usage * ## Most common usage
* *
* The most common usage of the `ngIf` directive is to conditionally show the inline template as * The most common usage of the `ngIf` directive is to conditionally show the inline template as
* seen in this example: * seen in this example:
* {@example common/ngIf/ts/module.ts region='NgIfSimple'} * {@example common/ngIf/ts/module.ts region='NgIfSimple'}
* *
* # Showing an alternative template using `else` * ## Showing an alternative template using `else`
* *
* If it is necessary to display a template when the `expression` is falsy use the `else` template * If it is necessary to display a template when the `expression` is falsy use the `else` template
* binding as shown. Note that the `else` binding points to a `<ng-template>` labeled `#elseBlock`. * binding as shown. Note that the `else` binding points to a `<ng-template>` labeled `#elseBlock`.
@ -32,7 +32,7 @@ import {Directive, EmbeddedViewRef, Input, TemplateRef, ViewContainerRef} from '
* *
* {@example common/ngIf/ts/module.ts region='NgIfElse'} * {@example common/ngIf/ts/module.ts region='NgIfElse'}
* *
* # Using non-inlined `then` template * ## Using non-inlined `then` template
* *
* Usually the `then` template is the inlined template of the `ngIf`, but it can be changed using * Usually the `then` template is the inlined template of the `ngIf`, but it can be changed using
* a binding (just like `else`). Because `then` and `else` are bindings, the template references can * a binding (just like `else`). Because `then` and `else` are bindings, the template references can
@ -40,7 +40,7 @@ import {Directive, EmbeddedViewRef, Input, TemplateRef, ViewContainerRef} from '
* *
* {@example common/ngIf/ts/module.ts region='NgIfThenElse'} * {@example common/ngIf/ts/module.ts region='NgIfThenElse'}
* *
* # Storing conditional result in a variable * ## Storing conditional result in a variable
* *
* A common pattern is that we need to show a set of properties from the same object. If the * A common pattern is that we need to show a set of properties from the same object. If the
* object is undefined, then we have to use the safe-traversal-operator `?.` to guard against * object is undefined, then we have to use the safe-traversal-operator `?.` to guard against

2
packages/common/src/directives/ng_template_outlet.ts
View File

@ -26,7 +26,7 @@ import {Directive, EmbeddedViewRef, Input, OnChanges, SimpleChanges, TemplateRef
* *
* Note: using the key `$implicit` in the context object will set it's value as default. * Note: using the key `$implicit` in the context object will set it's value as default.
* *
* # Example * ## Example
* *
* {@example common/ngTemplateOutlet/ts/module.ts region='NgTemplateOutlet'} * {@example common/ngTemplateOutlet/ts/module.ts region='NgTemplateOutlet'}
* *