cargdev/angular
1
0
Fork 0
Code Issues 10 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(core): migrate @whatItDoes tags to the description (#23185)

Browse Source 
We get the overview for the doc by splitting off the first
paragraph.

PR Close #23185
This commit is contained in:
Pete Bacon Darwin
2018-04-05 10:16:31 +01:00
committed by Igor Minar
parent 5bb14a68d2
commit 7dc150c1e8
11 changed files with 81 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
packages/core/src/metadata/di.ts
View File

@ -141,13 +141,13 @@ export abstract class Query {}
*/
export interface ContentChildrenDecorator {
/**
* @whatItDoes Configures a content query.
*
* @usageNotes
*
* {@example core/di/ts/contentChildren/content_children_howto.ts region='HowTo'}
*
* @description
* Configures a content query.
*
* You can use ContentChildren to get the {@link QueryList} of elements or directives from the
* content DOM. Any time a child element is added, removed, or moved, the query list will be
@ -203,13 +203,13 @@ export const ContentChildren: ContentChildrenDecorator = makePropDecorator(
*/
export interface ContentChildDecorator {
/**
* @whatItDoes Configures a content query.
*
* @usageNotes
*
* {@example core/di/ts/contentChild/content_child_howto.ts region='HowTo'}
*
* @description
* Configures a content query.
*
* You can use ContentChild to get the first element or the directive matching the selector from
* the content DOM. If the content DOM changes, and a new child matches the selector,
@ -264,13 +264,13 @@ export const ContentChild: ContentChildDecorator = makePropDecorator(
*/
export interface ViewChildrenDecorator {
/**
* @whatItDoes Configures a view query.
*
* @usageNotes
*
* {@example core/di/ts/viewChildren/view_children_howto.ts region='HowTo'}
*
* @description
* Configures a view query.
*
* You can use ViewChildren to get the {@link QueryList} of elements or directives from the
* view DOM. Any time a child element is added, removed, or moved, the query list will be updated,
@ -323,13 +323,13 @@ export const ViewChildren: ViewChildrenDecorator = makePropDecorator(
*/
export interface ViewChildDecorator {
/**
* @whatItDoes Configures a view query.
*
* @usageNotes
*
* {@example core/di/ts/viewChild/view_child_howto.ts region='HowTo'}
*
* @description
* Configures a view query.
*
* You can use ViewChild to get the first element or the directive matching the selector from the
* view DOM. If the view DOM changes, and a new child matches the selector,

12
packages/core/src/metadata/directives.ts
View File

@ -21,9 +21,6 @@ import {ViewEncapsulation} from './view';
*/
export interface DirectiveDecorator {
/**
* @whatItDoes Marks a class as an Angular directive and collects directive configuration
* metadata.
*
* @usageNotes
*
* ```
@ -38,6 +35,9 @@ export interface DirectiveDecorator {
*
* @description
*
* Marks a class as an Angular directive and collects directive configuration
* metadata.
*
* Directive decorator allows you to mark a class as an Angular directive and provide additional
* metadata that determines how the directive should be processed, instantiated and used at
* runtime.
@ -410,14 +410,14 @@ export const Directive: DirectiveDecorator =
*/
export interface ComponentDecorator {
/**
* @whatItDoes Marks a class as an Angular component and collects component configuration
* metadata.
*
* @usageNotes
*
* {@example core/ts/metadata/metadata.ts region='component'}
*
* @description
* Marks a class as an Angular component and collects component configuration
* metadata.
*
* Component decorator allows you to mark a class as an Angular component and provide additional
* metadata that determines how the component should be processed, instantiated and used at
* runtime.

30
packages/core/src/metadata/lifecycle_hooks.ts
View File

@ -17,11 +17,12 @@ import {SimpleChange} from '../change_detection/change_detection_util';
export interface SimpleChanges { [propName: string]: SimpleChange; }
/**
* @whatItDoes Lifecycle hook that is called when any data-bound property of a directive changes.
* @usageNotes
* {@example core/ts/metadata/lifecycle_hooks_spec.ts region='OnChanges'}
*
* @description
* Lifecycle hook that is called when any data-bound property of a directive changes.
*
* `ngOnChanges` is called right after the data-bound properties have been checked and before view
* and content children are checked if at least one of them has changed.
* The `changes` parameter contains the changed properties.
@ -33,12 +34,13 @@ export interface SimpleChanges { [propName: string]: SimpleChange; }
export interface OnChanges { ngOnChanges(changes: SimpleChanges): void; }
/**
* @whatItDoes Lifecycle hook that is called after data-bound properties of a directive are
* initialized.
* @usageNotes
* {@example core/ts/metadata/lifecycle_hooks_spec.ts region='OnInit'}
*
* @description
* Lifecycle hook that is called after data-bound properties of a directive are
* initialized.
*
* `ngOnInit` is called right after the directive's data-bound properties have been checked for the
* first time, and before any of its children have been checked. It is invoked only once when the
* directive is instantiated.
@ -50,11 +52,12 @@ export interface OnChanges { ngOnChanges(changes: SimpleChanges): void; }
export interface OnInit { ngOnInit(): void; }
/**
* @whatItDoes Lifecycle hook that is called when Angular dirty checks a directive.
* @usageNotes
* {@example core/ts/metadata/lifecycle_hooks_spec.ts region='DoCheck'}
*
* @description
* Lifecycle hook that is called when Angular dirty checks a directive.
*
* `ngDoCheck` gets called to check the changes in the directives in addition to the default
* algorithm. The default change detection algorithm looks for differences by comparing
* bound-property values by reference across change detection runs.
@ -73,11 +76,12 @@ export interface OnInit { ngOnInit(): void; }
export interface DoCheck { ngDoCheck(): void; }
/**
* @whatItDoes Lifecycle hook that is called when a directive, pipe or service is destroyed.
* @usageNotes
* {@example core/ts/metadata/lifecycle_hooks_spec.ts region='OnDestroy'}
*
* @description
* Lifecycle hook that is called when a directive, pipe or service is destroyed.
*
* `ngOnDestroy` callback is typically used for any custom cleanup that needs to occur when the
* instance is destroyed.
*
@ -89,12 +93,13 @@ export interface OnDestroy { ngOnDestroy(): void; }
/**
*
* @whatItDoes Lifecycle hook that is called after a directive's content has been fully
* initialized.
* @usageNotes
* {@example core/ts/metadata/lifecycle_hooks_spec.ts region='AfterContentInit'}
*
* @description
* Lifecycle hook that is called after a directive's content has been fully
* initialized.
*
* See {@linkDocs guide/lifecycle-hooks#aftercontent "Lifecycle Hooks Guide"}.
*
* @stable
@ -102,11 +107,12 @@ export interface OnDestroy { ngOnDestroy(): void; }
export interface AfterContentInit { ngAfterContentInit(): void; }
/**
* @whatItDoes Lifecycle hook that is called after every check of a directive's content.
* @usageNotes
* {@example core/ts/metadata/lifecycle_hooks_spec.ts region='AfterContentChecked'}
*
* @description
* Lifecycle hook that is called after every check of a directive's content.
*
* See {@linkDocs guide/lifecycle-hooks#aftercontent "Lifecycle Hooks Guide"}.
*
* @stable
@ -114,12 +120,13 @@ export interface AfterContentInit { ngAfterContentInit(): void; }
export interface AfterContentChecked { ngAfterContentChecked(): void; }
/**
* @whatItDoes Lifecycle hook that is called after a component's view has been fully
* initialized.
* @usageNotes
* {@example core/ts/metadata/lifecycle_hooks_spec.ts region='AfterViewInit'}
*
* @description
* Lifecycle hook that is called after a component's view has been fully
* initialized.
*
* See {@linkDocs guide/lifecycle-hooks#afterview "Lifecycle Hooks Guide"}.
*
* @stable
@ -127,11 +134,12 @@ export interface AfterContentChecked { ngAfterContentChecked(): void; }
export interface AfterViewInit { ngAfterViewInit(): void; }
/**
* @whatItDoes Lifecycle hook that is called after every check of a component's view.
* @usageNotes
* {@example core/ts/metadata/lifecycle_hooks_spec.ts region='AfterViewChecked'}
*
* @description
* Lifecycle hook that is called after every check of a component's view.
*
* See {@linkDocs guide/lifecycle-hooks#afterview "Lifecycle Hooks Guide"}.
*
* @stable