honeymoose/angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: fix misdirected group links (#24569)

Browse Source 
PR Close #24569
This commit is contained in:
Judy Bogart 2018-06-18 14:58:30 -07:00 committed by Miško Hevery
parent d244523ae6
commit 2a68ba4cbb
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
packages/animations/src/animation_metadata.ts
View File

@ -40,11 +40,12 @@ export declare type AnimateTimings = {
/** /**
* @description Options that control animation styling and timing. * @description Options that control animation styling and timing.
*
* The following animation functions accept `AnimationOptions` data: * The following animation functions accept `AnimationOptions` data:
* *
* - `transition()` * - `transition()`
* - `sequence()` * - `sequence()`
* - `group()` * - `{@link animations/group group()}`
* - `query()` * - `query()`
* - `animation()` * - `animation()`
* - `useAnimation()` * - `useAnimation()`
@ -100,7 +101,7 @@ export const enum AnimationMetadataType {
Sequence = 2, Sequence = 2,
/** /**
* Contains a set of animation steps. * Contains a set of animation steps.
* See `group()` * See `{@link animations/group group()}`
*/ */
Group = 3, Group = 3,
/** /**
@ -352,7 +353,7 @@ export interface AnimationSequenceMetadata extends AnimationMetadata {
/** /**
* Encapsulates an animation group. * Encapsulates an animation group.
* Instantiated and returned by the `group()` function. * Instantiated and returned by the `{@link animations/group group()}` function.
*/ */
export interface AnimationGroupMetadata extends AnimationMetadata { export interface AnimationGroupMetadata extends AnimationMetadata {
/** /**
@ -579,7 +580,7 @@ export function trigger(name: string, definitions: AnimationMetadata[]): Animati
* @returns An object that encapsulates the animation step. * @returns An object that encapsulates the animation step.
* *
* @usageNotes * @usageNotes
* Call within an animation `sequence()`, `group()`, or * Call within an animation `sequence()`, `{@link animations/group group()}`, or
* `transition()` call to specify an animation step * `transition()` call to specify an animation step
* that applies given style data to the parent animation for a given amount of time. * that applies given style data to the parent animation for a given amount of time.
* *
@ -676,9 +677,9 @@ export function group(
* @usageNotes * @usageNotes
* When you pass an array of steps to a * When you pass an array of steps to a
* `transition()` call, the steps run sequentially by default. * `transition()` call, the steps run sequentially by default.
* Compare this to the `group()` call, which runs animation steps in parallel. * Compare this to the `{@link animations/group group()}` call, which runs animation steps in parallel.
* *
* When a sequence is used within a `group()` or a `transition()` call, * When a sequence is used within a `{@link animations/group group()}` or a `transition()` call,
* execution continues to the next instruction only after each of the inner animation * execution continues to the next instruction only after each of the inner animation
* steps have completed. * steps have completed.
* *
@ -863,7 +864,7 @@ export function keyframes(steps: AnimationStyleMetadata[]): AnimationKeyframesSe
* ...] * ...]
* ``` * ```
* *
* Note that when you call the `sequence()` function within a `group()` * Note that when you call the `sequence()` function within a `{@link animations/group group()}`
* or a `transition()` call, execution does not continue to the next instruction * or a `transition()` call, execution does not continue to the next instruction
* until each of the inner animation steps have completed. * until each of the inner animation steps have completed.
* *