refactor(core): document setComponentScope to provide context (#39662)

`setComponentScope` was previously undocumented. This commit adds a short
explanation of what the function does, and adds a link to a doc which
explains issues with cycles in more detail.

PR Close #39662
This commit is contained in:
Alex Rickabaugh 2020-11-12 16:29:36 -08:00 committed by atscott
parent c59f401f9a
commit 24e13e0ed6
1 changed files with 6 additions and 0 deletions

View File

@ -352,6 +352,12 @@ export function ɵɵdefineComponent<T>(componentDefinition: {
} }
/** /**
* Generated next to NgModules to monkey-patch directive and pipe references onto a component's
* definition, when generating a direct reference in the component file would otherwise create an
* import cycle.
*
* See [this explanation](https://hackmd.io/Odw80D0pR6yfsOjg_7XCJg?view) for more details.
*
* @codeGenApi * @codeGenApi
*/ */
export function ɵɵsetComponentScope( export function ɵɵsetComponentScope(