docs: clean up api doc in core (#37053)

Add introductions to usage examples and edit descriptions to be more complete and consistent with current API reference styles

PR Close #37053
This commit is contained in:
Judy Bogart
2020-05-11 14:57:23 -07:00
committed by Andrew Kushnir
parent 11dd2bef2d
commit 9206a26e1d
9 changed files with 65 additions and 61 deletions

View File

@ -9,10 +9,13 @@
import {injectChangeDetectorRef as render3InjectChangeDetectorRef} from '../render3/view_engine_compatibility';
/**
* Base class for Angular Views, provides change detection functionality.
* Base class that provides change detection functionality.
* A change-detection tree collects all views that are to be checked for changes.
* Use the methods to add and remove views from the tree, initiate change-detection,
* and explicitly mark views as _dirty_, meaning that they have changed and need to be rerendered.
* and explicitly mark views as _dirty_, meaning that they have changed and need to be re-rendered.
*
* @see [Using change detection hooks](guide/lifecycle-hooks#using-change-detection-hooks)
* @see [Defining custom change detection](guide/lifecycle-hooks#defining-custom-change-detection)
*
* @usageNotes
*

View File

@ -11,6 +11,8 @@
* The strategy that the default change detector uses to detect changes.
* When set, takes effect the next time change detection is triggered.
*
* @see {@link ChangeDetectorRef#usage-notes Change detection usage}
*
* @publicApi
*/
export enum ChangeDetectionStrategy {