Skip to content
This repository was archived by the owner on Aug 30, 2023. It is now read-only.

Commit 024296a

Browse files
authored
Standardize our param docs formatting. (#95)
1 parent e41ccb4 commit 024296a

File tree

1 file changed

+38
-27
lines changed

1 file changed

+38
-27
lines changed

src/MDMMotionAnimator.h

Lines changed: 38 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,14 @@ NS_SWIFT_NAME(MotionAnimator)
7171
In this case, multiple invocations of this function on the same key path will remove the
7272
animations added from prior invocations.
7373
74-
@param traits The traits to be used for the animation.
75-
@param layer The layer to be animated.
76-
@param values The values to be used in the animation. Must contain exactly two values. Supported
77-
UIKit types will be coerced to their Core Animation equivalent. Supported UIKit values include
78-
UIColor and UIBezierPath.
74+
@param traits The traits to be used for the animation.
75+
76+
@param layer The layer to be animated.
77+
78+
@param values The values to be used in the animation. Must contain exactly two values. Supported
79+
UIKit types will be coerced to their Core Animation equivalent. Supported UIKit
80+
values include UIColor and UIBezierPath.
81+
7982
@param keyPath The key path of the property to be animated.
8083
*/
8184
- (void)animateWithTraits:(nonnull MDMAnimationTraits *)traits
@@ -90,16 +93,20 @@ NS_SWIFT_NAME(MotionAnimator)
9093
In this case, multiple invocations of this function on the same key path will remove the
9194
animations added from prior invocations.
9295
93-
@param traits The traits to be used for the animation.
94-
@param layer The layer to be animated.
95-
@param values The values to be used in the animation. Must contain exactly two values. Supported
96-
UIKit types will be coerced to their Core Animation equivalent. Supported UIKit values include
97-
UIColor and UIBezierPath.
98-
@param keyPath The key path of the property to be animated.
99-
@param completion A block object to be executed when the animation ends or is removed from the
100-
animation hierarchy. If the duration of the animation is 0, this block is executed immediately.
101-
The block is escaping and will be released once the animations have completed. The provided
102-
`finished` argument is currently always YES.
96+
@param traits The traits to be used for the animation.
97+
98+
@param layer The layer to be animated.
99+
100+
@param values The values to be used in the animation. Must contain exactly two values.
101+
Supported UIKit types will be coerced to their Core Animation equivalent.
102+
103+
@param keyPath The key path of the property to be animated.
104+
105+
@param completion A block object to be executed when the animation ends or is removed from the
106+
animation hierarchy. If the duration of the animation is 0, this block is
107+
executed immediately. The block is escaping and will be released once the
108+
animations have completed. The provided `finished` argument is currently always
109+
YES.
103110
*/
104111
- (void)animateWithTraits:(nonnull MDMAnimationTraits *)traits
105112
between:(nonnull NSArray *)values
@@ -121,10 +128,11 @@ NS_SWIFT_NAME(MotionAnimator)
121128
/**
122129
Performs `animations` using the traits provided.
123130
124-
@param traits The traits to be used for the animation.
125-
@param animations The block to be executed. Any animatable properties changed within this block
126-
will result in animations being added to the view's layer with the provided traits. The block is
127-
non-escaping.
131+
@param traits The traits to be used for the animation.
132+
133+
@param animations The block to be executed. Any animatable properties changed within this block
134+
will result in animations being added to the view's layer with the provided
135+
traits. The block is non-escaping.
128136
*/
129137
- (void)animateWithTraits:(nonnull MDMAnimationTraits *)traits
130138
animations:(nonnull void(^)(void))animations;
@@ -133,14 +141,17 @@ NS_SWIFT_NAME(MotionAnimator)
133141
Performs `animations` using the traits provided and executes the completion handler once all added
134142
animations have completed.
135143
136-
@param traits The traits to be used for the animation.
137-
@param animations The block to be executed. Any animatable properties changed within this block
138-
will result in animations being added to the view's layer with the provided traits. The block is
139-
non-escaping.
140-
@param completion A block object to be executed once the animation sequence ends or it has been
141-
removed from the animation hierarchy. If the duration of the animation is 0, this block is executed
142-
immediately. The block is escaping and will be released once the animation sequence has completed.
143-
The provided `finished` argument is currently always YES.
144+
@param traits The traits to be used for the animation.
145+
146+
@param animations The block to be executed. Any animatable properties changed within this block
147+
will result in animations being added to the view's layer with the provided
148+
traits. The block is non-escaping.
149+
150+
@param completion A block object to be executed once the animation sequence ends or it has been
151+
removed from the animation hierarchy. If the duration of the animation is 0,
152+
this block is executed immediately. The block is escaping and will be released
153+
once the animation sequence has completed. The provided `finished` argument is
154+
currently always YES.
144155
*/
145156
- (void)animateWithTraits:(nonnull MDMAnimationTraits *)traits
146157
animations:(nonnull void (^)(void))animations

0 commit comments

Comments
 (0)