refactor(docs-infra): remove linenums=false since it is now the default (#31674)
PR Close #31674
This commit is contained in:
George Kalpakas
committed by
Miško Hevery
Miško Hevery
parent
dd0be7feb7
commit
1bcd58cee8
@ -46,8 +46,7 @@ export interface InjectableDecorator {
|
||||
* The following example shows how a service class is properly
|
||||
* marked so that a supporting service can be injected upon creation.
|
||||
*
|
||||
* <code-example path="core/di/ts/metadata_spec.ts" region="Injectable"
|
||||
* linenums="false"></code-example>
|
||||
* <code-example path="core/di/ts/metadata_spec.ts" region="Injectable"></code-example>
|
||||
*
|
||||
*/
|
||||
(): TypeDecorator;
|
||||
|
||||
@ -29,11 +29,11 @@ export interface ValueSansProvider {
|
||||
*
|
||||
* ### Example
|
||||
*
|
||||
* {@example core/di/ts/provider_spec.ts region='ValueProvider' linenums="false"}
|
||||
* {@example core/di/ts/provider_spec.ts region='ValueProvider'}
|
||||
*
|
||||
* ### Multi-value example
|
||||
*
|
||||
* {@example core/di/ts/provider_spec.ts region='MultiProviderAspect' linenums="false"}
|
||||
* {@example core/di/ts/provider_spec.ts region='MultiProviderAspect'}
|
||||
*
|
||||
* @publicApi
|
||||
*/
|
||||
@ -80,11 +80,11 @@ export interface StaticClassSansProvider {
|
||||
*
|
||||
* Note that following two providers are not equal:
|
||||
*
|
||||
* {@example core/di/ts/provider_spec.ts region='StaticClassProviderDifference' linenums="false"}
|
||||
* {@example core/di/ts/provider_spec.ts region='StaticClassProviderDifference'}
|
||||
*
|
||||
* ### Multi-value example
|
||||
*
|
||||
* {@example core/di/ts/provider_spec.ts region='MultiProviderAspect' linenums="false"}
|
||||
* {@example core/di/ts/provider_spec.ts region='MultiProviderAspect'}
|
||||
*
|
||||
* @publicApi
|
||||
*/
|
||||
@ -129,11 +129,11 @@ export interface ConstructorSansProvider {
|
||||
*
|
||||
* @usageNotes
|
||||
*
|
||||
* {@example core/di/ts/provider_spec.ts region='ConstructorProvider' linenums="false"}
|
||||
* {@example core/di/ts/provider_spec.ts region='ConstructorProvider'}
|
||||
*
|
||||
* ### Multi-value example
|
||||
*
|
||||
* {@example core/di/ts/provider_spec.ts region='MultiProviderAspect' linenums="false"}
|
||||
* {@example core/di/ts/provider_spec.ts region='MultiProviderAspect'}
|
||||
*
|
||||
* @publicApi
|
||||
*/
|
||||
@ -172,11 +172,11 @@ export interface ExistingSansProvider {
|
||||
*
|
||||
* @usageNotes
|
||||
*
|
||||
* {@example core/di/ts/provider_spec.ts region='ExistingProvider' linenums="false"}
|
||||
* {@example core/di/ts/provider_spec.ts region='ExistingProvider'}
|
||||
*
|
||||
* ### Multi-value example
|
||||
*
|
||||
* {@example core/di/ts/provider_spec.ts region='MultiProviderAspect' linenums="false"}
|
||||
* {@example core/di/ts/provider_spec.ts region='MultiProviderAspect'}
|
||||
*
|
||||
* @publicApi
|
||||
*/
|
||||
@ -221,15 +221,15 @@ export interface FactorySansProvider {
|
||||
*
|
||||
* @usageNotes
|
||||
*
|
||||
* {@example core/di/ts/provider_spec.ts region='FactoryProvider' linenums="false"}
|
||||
* {@example core/di/ts/provider_spec.ts region='FactoryProvider'}
|
||||
*
|
||||
* Dependencies can also be marked as optional:
|
||||
*
|
||||
* {@example core/di/ts/provider_spec.ts region='FactoryProviderOptionalDeps' linenums="false"}
|
||||
* {@example core/di/ts/provider_spec.ts region='FactoryProviderOptionalDeps'}
|
||||
*
|
||||
* ### Multi-value example
|
||||
*
|
||||
* {@example core/di/ts/provider_spec.ts region='MultiProviderAspect' linenums="false"}
|
||||
* {@example core/di/ts/provider_spec.ts region='MultiProviderAspect'}
|
||||
*
|
||||
* @publicApi
|
||||
*/
|
||||
@ -266,7 +266,7 @@ export type StaticProvider = ValueProvider | ExistingProvider | StaticClassProvi
|
||||
*
|
||||
* @usageNotes
|
||||
*
|
||||
* {@example core/di/ts/provider_spec.ts region='TypeProvider' linenums="false"}
|
||||
* {@example core/di/ts/provider_spec.ts region='TypeProvider'}
|
||||
*
|
||||
* @publicApi
|
||||
*/
|
||||
@ -293,15 +293,15 @@ export interface ClassSansProvider {
|
||||
*
|
||||
* @usageNotes
|
||||
*
|
||||
* {@example core/di/ts/provider_spec.ts region='ClassProvider' linenums="false"}
|
||||
* {@example core/di/ts/provider_spec.ts region='ClassProvider'}
|
||||
*
|
||||
* Note that following two providers are not equal:
|
||||
*
|
||||
* {@example core/di/ts/provider_spec.ts region='ClassProviderDifference' linenums="false"}
|
||||
* {@example core/di/ts/provider_spec.ts region='ClassProviderDifference'}
|
||||
*
|
||||
* ### Multi-value example
|
||||
*
|
||||
* {@example core/di/ts/provider_spec.ts region='MultiProviderAspect' linenums="false"}
|
||||
* {@example core/di/ts/provider_spec.ts region='MultiProviderAspect'}
|
||||
*
|
||||
* @publicApi
|
||||
*/
|
||||
|
||||
@ -29,8 +29,8 @@ export interface InjectDecorator {
|
||||
* When `@Inject()` is not present, the injector uses the type annotation of the
|
||||
* parameter as the provider.
|
||||
*
|
||||
* <code-example path="core/di/ts/metadata_spec.ts"
|
||||
* region="InjectWithoutDecorator" linenums="false"></code-example>
|
||||
* <code-example path="core/di/ts/metadata_spec.ts" region="InjectWithoutDecorator">
|
||||
* </code-example>
|
||||
*/
|
||||
(token: any): any;
|
||||
new (token: any): Inject;
|
||||
@ -77,8 +77,8 @@ export interface OptionalDecorator {
|
||||
*
|
||||
* The following code allows the possibility of a null result:
|
||||
*
|
||||
* <code-example path="core/di/ts/metadata_spec.ts" region="Optional"
|
||||
* linenums="false"></code-example>
|
||||
* <code-example path="core/di/ts/metadata_spec.ts" region="Optional">
|
||||
* </code-example>
|
||||
*
|
||||
*/
|
||||
(): any;
|
||||
@ -119,8 +119,8 @@ export interface SelfDecorator {
|
||||
* by the local injector when instantiating the class itself, but not
|
||||
* when instantiating a child.
|
||||
*
|
||||
* <code-example path="core/di/ts/metadata_spec.ts" region="Self"
|
||||
* linenums="false"></code-example>
|
||||
* <code-example path="core/di/ts/metadata_spec.ts" region="Self">
|
||||
* </code-example>
|
||||
*
|
||||
*
|
||||
* @see `SkipSelf`
|
||||
@ -164,8 +164,8 @@ export interface SkipSelfDecorator {
|
||||
* In the following example, the dependency can be resolved when
|
||||
* instantiating a child, but not when instantiating the class itself.
|
||||
*
|
||||
* <code-example path="core/di/ts/metadata_spec.ts" region="SkipSelf"
|
||||
* linenums="false"></code-example>
|
||||
* <code-example path="core/di/ts/metadata_spec.ts" region="SkipSelf">
|
||||
* </code-example>
|
||||
*
|
||||
* Learn more in the
|
||||
* [Dependency Injection guide](guide/dependency-injection-in-action#skip).
|
||||
@ -211,8 +211,8 @@ export interface HostDecorator {
|
||||
*
|
||||
* The following shows use with the `@Optional` decorator, and allows for a null result.
|
||||
*
|
||||
* <code-example path="core/di/ts/metadata_spec.ts" region="Host"
|
||||
* linenums="false"></code-example>
|
||||
* <code-example path="core/di/ts/metadata_spec.ts" region="Host">
|
||||
* </code-example>
|
||||
*/
|
||||
(): any;
|
||||
new (): Host;
|
||||
@ -254,11 +254,11 @@ export interface AttributeDecorator {
|
||||
*
|
||||
* The following example uses the decorator to inject the string literal `text`.
|
||||
*
|
||||
* {@example core/ts/metadata/metadata.ts region='attributeMetadata' linenums="false"}
|
||||
* {@example core/ts/metadata/metadata.ts region='attributeMetadata'}
|
||||
*
|
||||
* ### Example as TypeScript Decorator
|
||||
*
|
||||
* {@example core/ts/metadata/metadata.ts region='attributeFactory' linenums="false"}
|
||||
* {@example core/ts/metadata/metadata.ts region='attributeFactory'}
|
||||
*
|
||||
*/
|
||||
(name: string): any;
|
||||
|
||||
@ -69,8 +69,7 @@ export interface AttributeDecorator {
|
||||
*
|
||||
* A decorator can inject string literal `text` as in the following example.
|
||||
*
|
||||
* {@example core/ts/metadata/metadata.ts region='attributeMetadata'
|
||||
* linenums="false"}
|
||||
* {@example core/ts/metadata/metadata.ts region='attributeMetadata'}
|
||||
*
|
||||
* @publicApi
|
||||
*/
|
||||
@ -143,16 +142,14 @@ export interface ContentChildrenDecorator {
|
||||
*
|
||||
* Here is a simple demonstration of how the `ContentChildren` decorator can be used.
|
||||
*
|
||||
* {@example core/di/ts/contentChildren/content_children_howto.ts region='HowTo'
|
||||
* linenums="false"}
|
||||
* {@example core/di/ts/contentChildren/content_children_howto.ts region='HowTo'}
|
||||
*
|
||||
* ### Tab-pane example
|
||||
*
|
||||
* Here is a slightly more realistic example that shows how `ContentChildren` decorators
|
||||
* can be used to implement a tab pane component.
|
||||
*
|
||||
* {@example core/di/ts/contentChildren/content_children_example.ts region='Component'
|
||||
* linenums="false"}
|
||||
* {@example core/di/ts/contentChildren/content_children_example.ts region='Component'}
|
||||
*
|
||||
* @Annotation
|
||||
*/
|
||||
@ -211,13 +208,11 @@ export interface ContentChildDecorator {
|
||||
*
|
||||
* @usageNotes
|
||||
*
|
||||
* {@example core/di/ts/contentChild/content_child_howto.ts region='HowTo'
|
||||
* linenums="false"}
|
||||
* {@example core/di/ts/contentChild/content_child_howto.ts region='HowTo'}
|
||||
*
|
||||
* ### Example
|
||||
*
|
||||
* {@example core/di/ts/contentChild/content_child_example.ts region='Component'
|
||||
* linenums="false"}
|
||||
* {@example core/di/ts/contentChild/content_child_example.ts region='Component'}
|
||||
*
|
||||
* @Annotation
|
||||
*/
|
||||
@ -269,13 +264,11 @@ export interface ViewChildrenDecorator {
|
||||
*
|
||||
* @usageNotes
|
||||
*
|
||||
* {@example core/di/ts/viewChildren/view_children_howto.ts region='HowTo'
|
||||
* linenums="false"}
|
||||
* {@example core/di/ts/viewChildren/view_children_howto.ts region='HowTo'}
|
||||
*
|
||||
* ### Another example
|
||||
*
|
||||
* {@example core/di/ts/viewChildren/view_children_example.ts region='Component'
|
||||
* linenums="false"}
|
||||
* {@example core/di/ts/viewChildren/view_children_example.ts region='Component'}
|
||||
*
|
||||
* @Annotation
|
||||
*/
|
||||
@ -341,13 +334,11 @@ export interface ViewChildDecorator {
|
||||
*
|
||||
* @usageNotes
|
||||
*
|
||||
* {@example core/di/ts/viewChild/view_child_example.ts region='Component'
|
||||
* linenums="false"}
|
||||
* {@example core/di/ts/viewChild/view_child_example.ts region='Component'}
|
||||
*
|
||||
* ### Example 2
|
||||
*
|
||||
* {@example core/di/ts/viewChild/view_child_howto.ts region='HowTo'
|
||||
* linenums="false"}
|
||||
* {@example core/di/ts/viewChild/view_child_howto.ts region='HowTo'}
|
||||
*
|
||||
* @Annotation
|
||||
*/
|
||||
|
||||
@ -332,9 +332,7 @@ export interface ComponentDecorator {
|
||||
* The following example creates a component with two data-bound properties,
|
||||
* specified by the `inputs` value.
|
||||
*
|
||||
* <code-example path="core/ts/metadata/directives.ts" region="component-input"
|
||||
* linenums="false">
|
||||
* </code-example>
|
||||
* <code-example path="core/ts/metadata/directives.ts" region="component-input"></code-example>
|
||||
*
|
||||
*
|
||||
* ### Setting component outputs
|
||||
@ -342,8 +340,7 @@ export interface ComponentDecorator {
|
||||
* The following example shows two event emitters that emit on an interval. One
|
||||
* emits an output every second, while the other emits every five seconds.
|
||||
*
|
||||
* {@example core/ts/metadata/directives.ts region='component-output-interval
|
||||
* linenums="false"}
|
||||
* {@example core/ts/metadata/directives.ts region='component-output-interval'}
|
||||
*
|
||||
* ### Injecting a class with a view provider
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user