docs(core): migrate deprecated @howToUse tags (#23185)

These have now become `@usageNotes` but later they might be
moved into a section of the description.

PR Close #23185
This commit is contained in:
Pete Bacon Darwin
2018-04-05 09:58:02 +01:00
committed by Igor Minar
parent 381da1af45
commit 5bb14a68d2
7 changed files with 36 additions and 36 deletions

View File

@ -143,7 +143,7 @@ export interface ContentChildrenDecorator {
/**
* @whatItDoes Configures a content query.
*
* @howToUse
* @usageNotes
*
* {@example core/di/ts/contentChildren/content_children_howto.ts region='HowTo'}
*
@ -205,7 +205,7 @@ export interface ContentChildDecorator {
/**
* @whatItDoes Configures a content query.
*
* @howToUse
* @usageNotes
*
* {@example core/di/ts/contentChild/content_child_howto.ts region='HowTo'}
*
@ -266,7 +266,7 @@ export interface ViewChildrenDecorator {
/**
* @whatItDoes Configures a view query.
*
* @howToUse
* @usageNotes
*
* {@example core/di/ts/viewChildren/view_children_howto.ts region='HowTo'}
*
@ -325,7 +325,7 @@ export interface ViewChildDecorator {
/**
* @whatItDoes Configures a view query.
*
* @howToUse
* @usageNotes
*
* {@example core/di/ts/viewChild/view_child_howto.ts region='HowTo'}
*

View File

@ -24,7 +24,7 @@ export interface DirectiveDecorator {
* @whatItDoes Marks a class as an Angular directive and collects directive configuration
* metadata.
*
* @howToUse
* @usageNotes
*
* ```
* import {Directive} from '@angular/core';
@ -413,7 +413,7 @@ export interface ComponentDecorator {
* @whatItDoes Marks a class as an Angular component and collects component configuration
* metadata.
*
* @howToUse
* @usageNotes
*
* {@example core/ts/metadata/metadata.ts region='component'}
*

View File

@ -18,7 +18,7 @@ export interface SimpleChanges { [propName: string]: SimpleChange; }
/**
* @whatItDoes Lifecycle hook that is called when any data-bound property of a directive changes.
* @howToUse
* @usageNotes
* {@example core/ts/metadata/lifecycle_hooks_spec.ts region='OnChanges'}
*
* @description
@ -35,7 +35,7 @@ export interface OnChanges { ngOnChanges(changes: SimpleChanges): void; }
/**
* @whatItDoes Lifecycle hook that is called after data-bound properties of a directive are
* initialized.
* @howToUse
* @usageNotes
* {@example core/ts/metadata/lifecycle_hooks_spec.ts region='OnInit'}
*
* @description
@ -51,7 +51,7 @@ export interface OnInit { ngOnInit(): void; }
/**
* @whatItDoes Lifecycle hook that is called when Angular dirty checks a directive.
* @howToUse
* @usageNotes
* {@example core/ts/metadata/lifecycle_hooks_spec.ts region='DoCheck'}
*
* @description
@ -74,7 +74,7 @@ export interface DoCheck { ngDoCheck(): void; }
/**
* @whatItDoes Lifecycle hook that is called when a directive, pipe or service is destroyed.
* @howToUse
* @usageNotes
* {@example core/ts/metadata/lifecycle_hooks_spec.ts region='OnDestroy'}
*
* @description
@ -91,7 +91,7 @@ export interface OnDestroy { ngOnDestroy(): void; }
*
* @whatItDoes Lifecycle hook that is called after a directive's content has been fully
* initialized.
* @howToUse
* @usageNotes
* {@example core/ts/metadata/lifecycle_hooks_spec.ts region='AfterContentInit'}
*
* @description
@ -103,7 +103,7 @@ export interface AfterContentInit { ngAfterContentInit(): void; }
/**
* @whatItDoes Lifecycle hook that is called after every check of a directive's content.
* @howToUse
* @usageNotes
* {@example core/ts/metadata/lifecycle_hooks_spec.ts region='AfterContentChecked'}
*
* @description
@ -116,7 +116,7 @@ export interface AfterContentChecked { ngAfterContentChecked(): void; }
/**
* @whatItDoes Lifecycle hook that is called after a component's view has been fully
* initialized.
* @howToUse
* @usageNotes
* {@example core/ts/metadata/lifecycle_hooks_spec.ts region='AfterViewInit'}
*
* @description
@ -128,7 +128,7 @@ export interface AfterViewInit { ngAfterViewInit(): void; }
/**
* @whatItDoes Lifecycle hook that is called after every check of a component's view.
* @howToUse
* @usageNotes
* {@example core/ts/metadata/lifecycle_hooks_spec.ts region='AfterViewChecked'}
*
* @description