Skip to content

Commit 4f4427c

Browse files
mairawRon Petrusha
mairaw
and
Ron Petrusha
authored
import UWP content from IntelliSense - Windows.UI.Xaml.Media.* (#2475)
* import UWP content from IntelliSense * minor edits * Apply suggestions from peer review Co-Authored-By: Ron Petrusha <[email protected]>
1 parent d5bc916 commit 4f4427c

File tree

5 files changed

+231
-223
lines changed

5 files changed

+231
-223
lines changed

‎xml/Windows.UI.Xaml.Media.Animation/KeyTime.xml

Lines changed: 33 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
23+
<summary>Specifies when a particular key frame should take place during an animation. </summary>
2424
<remarks>To be added.</remarks>
2525
</Docs>
2626
<Members>
@@ -49,9 +49,9 @@
4949
<Parameter Name="value" Type="System.Object" />
5050
</Parameters>
5151
<Docs>
52-
<param name="value">To be added.</param>
53-
<summary>To be added.</summary>
54-
<returns>To be added.</returns>
52+
<param name="value">The <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" /> to compare with this <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" />.</param>
53+
<summary>Indicates whether a <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" /> is equal to this <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" />.</summary>
54+
<returns><see langword="true" /> if <paramref name="value" /> is a <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" /> that represents the same length of time as this <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" />; otherwise, <see langword="false" />.</returns>
5555
<remarks>To be added.</remarks>
5656
</Docs>
5757
</Member>
@@ -75,9 +75,9 @@
7575
<Parameter Name="value" Type="Windows.UI.Xaml.Media.Animation.KeyTime" />
7676
</Parameters>
7777
<Docs>
78-
<param name="value">To be added.</param>
79-
<summary>To be added.</summary>
80-
<returns>To be added.</returns>
78+
<param name="value">The <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" /> to compare with this <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" />.</param>
79+
<summary>Indicates whether a specified <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" /> is equal to this <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" />.</summary>
80+
<returns><see langword="true" /> if <paramref name="value" /> is equal to this <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" />; otherwise, <see langword="false" />.</returns>
8181
<remarks>To be added.</remarks>
8282
</Docs>
8383
</Member>
@@ -102,10 +102,10 @@
102102
<Parameter Name="keyTime2" Type="Windows.UI.Xaml.Media.Animation.KeyTime" />
103103
</Parameters>
104104
<Docs>
105-
<param name="keyTime1">To be added.</param>
106-
<param name="keyTime2">To be added.</param>
107-
<summary>To be added.</summary>
108-
<returns>To be added.</returns>
105+
<param name="keyTime1">The first value to compare.</param>
106+
<param name="keyTime2">The second value to compare.</param>
107+
<summary>Indicates whether two <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" /> values are equal.</summary>
108+
<returns><see langword="true" /> if the values of <paramref name="keyTime1" /> and <paramref name="keyTime2" /> are equal; otherwise, <see langword="false" />.</returns>
109109
<remarks>To be added.</remarks>
110110
</Docs>
111111
</Member>
@@ -128,10 +128,11 @@
128128
<Parameter Name="timeSpan" Type="System.TimeSpan" />
129129
</Parameters>
130130
<Docs>
131-
<param name="timeSpan">To be added.</param>
132-
<summary>To be added.</summary>
133-
<returns>To be added.</returns>
131+
<param name="timeSpan">The value of the new <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" />.</param>
132+
<summary>Creates a new <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" />, using the supplied <see cref="T:System.TimeSpan" />.</summary>
133+
<returns>A new <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" />, initialized to the value of <paramref name="timeSpan" />.</returns>
134134
<remarks>To be added.</remarks>
135+
<exception cref="T:System.ArgumentOutOfRangeException">The specified <paramref name="timeSpan" /> is outside the allowed range.</exception>
135136
</Docs>
136137
</Member>
137138
<Member MemberName="GetHashCode">
@@ -157,8 +158,8 @@
157158
</ReturnValue>
158159
<Parameters />
159160
<Docs>
160-
<summary>To be added.</summary>
161-
<returns>To be added.</returns>
161+
<summary>Returns a hash code representing this <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" />.</summary>
162+
<returns>A hash code.</returns>
162163
<remarks>To be added.</remarks>
163164
</Docs>
164165
</Member>
@@ -183,10 +184,10 @@
183184
<Parameter Name="keyTime2" Type="Windows.UI.Xaml.Media.Animation.KeyTime" />
184185
</Parameters>
185186
<Docs>
186-
<param name="keyTime1">To be added.</param>
187-
<param name="keyTime2">To be added.</param>
188-
<summary>To be added.</summary>
189-
<returns>To be added.</returns>
187+
<param name="keyTime1">The first value to compare.</param>
188+
<param name="keyTime2">The second value to compare.</param>
189+
<summary>Compares two <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" /> values for equality.</summary>
190+
<returns><see langword="true" /> if <paramref name="keyTime1" /> and <paramref name="keyTime2" /> are equal; otherwise, <see langword="false" />.</returns>
190191
<remarks>To be added.</remarks>
191192
</Docs>
192193
</Member>
@@ -209,9 +210,9 @@
209210
<Parameter Name="timeSpan" Type="System.TimeSpan" />
210211
</Parameters>
211212
<Docs>
212-
<param name="timeSpan">To be added.</param>
213-
<summary>To be added.</summary>
214-
<returns>To be added.</returns>
213+
<param name="timeSpan">The <see cref="P:Windows.UI.Xaml.Media.Animation.KeyTime.TimeSpan" /> value to convert.</param>
214+
<summary>Implicitly converts a <see cref="P:Windows.UI.Xaml.Media.Animation.KeyTime.TimeSpan" /> to a <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" />.</summary>
215+
<returns>The created <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" />.</returns>
215216
<remarks>To be added.</remarks>
216217
</Docs>
217218
</Member>
@@ -236,10 +237,10 @@
236237
<Parameter Name="keyTime2" Type="Windows.UI.Xaml.Media.Animation.KeyTime" />
237238
</Parameters>
238239
<Docs>
239-
<param name="keyTime1">To be added.</param>
240-
<param name="keyTime2">To be added.</param>
241-
<summary>To be added.</summary>
242-
<returns>To be added.</returns>
240+
<param name="keyTime1">The first value to compare.</param>
241+
<param name="keyTime2">The second value to compare.</param>
242+
<summary>Compares two <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" /> values for inequality.</summary>
243+
<returns><see langword="true" /> if <paramref name="keyTime1" /> and <paramref name="keyTime2" /> are not equal; otherwise, false. </returns>
243244
<remarks>To be added.</remarks>
244245
</Docs>
245246
</Member>
@@ -260,8 +261,8 @@
260261
<ReturnType>System.TimeSpan</ReturnType>
261262
</ReturnValue>
262263
<Docs>
263-
<summary>To be added.</summary>
264-
<value>To be added.</value>
264+
<summary>Gets the time when the key frame ends, expressed as a time relative to the beginning of the animation.</summary>
265+
<value>The time when the key frame ends, expressed as a time relative to the beginning of the animation.</value>
265266
<remarks>To be added.</remarks>
266267
</Docs>
267268
</Member>
@@ -288,10 +289,10 @@
288289
</ReturnValue>
289290
<Parameters />
290291
<Docs>
291-
<summary>To be added.</summary>
292-
<returns>To be added.</returns>
292+
<summary>Returns a string representation of this <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" />. </summary>
293+
<returns>A string representation of this <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" />.</returns>
293294
<remarks>To be added.</remarks>
294295
</Docs>
295296
</Member>
296297
</Members>
297-
</Type>
298+
</Type>

‎xml/Windows.UI.Xaml.Media.Animation/RepeatBehavior.xml

Lines changed: 53 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
</Attribute>
2525
</Attributes>
2626
<Docs>
27-
<summary>To be added.</summary>
27+
<summary>Describes how a <see cref="T:Windows.UI.Xaml.Media.Animation.Timeline" /> repeats its simple duration.</summary>
2828
<remarks>To be added.</remarks>
2929
</Docs>
3030
<Members>
@@ -45,9 +45,11 @@
4545
<Parameter Name="count" Type="System.Double" />
4646
</Parameters>
4747
<Docs>
48-
<param name="count">To be added.</param>
49-
<summary>To be added.</summary>
48+
<param name="count">A number greater than or equal to 0 that specifies the number of iterations for an animation.</param>
49+
<summary>Initializes a new instance of the <see cref="T:Windows.UI.Xaml.Media.Animation.RepeatBehavior" /> struct with the specified iteration count.</summary>
5050
<remarks>To be added.</remarks>
51+
<exception cref="T:System.ArgumentOutOfRangeException">
52+
<paramref name="count" /> evaluates to infinity, a value that is not a number, or is negative.</exception>
5153
</Docs>
5254
</Member>
5355
<Member MemberName=".ctor">
@@ -67,9 +69,11 @@
6769
<Parameter Name="duration" Type="System.TimeSpan" />
6870
</Parameters>
6971
<Docs>
70-
<param name="duration">To be added.</param>
71-
<summary>To be added.</summary>
72+
<param name="duration">The total length of time that the Windows.UI.Xaml.Media.Animation.Timeline should play (its active duration).</param>
73+
<summary>Initializes a new instance of the <see cref="T:Windows.UI.Xaml.Media.Animation.RepeatBehavior" /> struct with the specified repeat duration.</summary>
7274
<remarks>To be added.</remarks>
75+
<exception cref="T:System.ArgumentOutOfRangeException">
76+
<paramref name="duration" /> evaluates to a negative time interval.</exception>
7377
</Docs>
7478
</Member>
7579
<Member MemberName="Count">
@@ -89,9 +93,10 @@
8993
<ReturnType>System.Double</ReturnType>
9094
</ReturnValue>
9195
<Docs>
92-
<summary>To be added.</summary>
93-
<value>To be added.</value>
96+
<summary>Gets the number of times a Windows.UI.Xaml.Media.Animation.Timeline should repeat.</summary>
97+
<value>The number of iterations to repeat.</value>
9498
<remarks>To be added.</remarks>
99+
<exception cref="T:System.InvalidOperationException">This <see cref="T:Windows.UI.Xaml.Media.Animation.RepeatBehavior" /> describes a repeat duration, not an iteration count.</exception>
95100
</Docs>
96101
</Member>
97102
<Member MemberName="Duration">
@@ -111,9 +116,10 @@
111116
<ReturnType>System.TimeSpan</ReturnType>
112117
</ReturnValue>
113118
<Docs>
114-
<summary>To be added.</summary>
115-
<value>To be added.</value>
119+
<summary>Gets the total length of time a Windows.UI.Xaml.Media.Animation.Timeline should play.</summary>
120+
<value>The total length of time a timeline should play.</value>
116121
<remarks>To be added.</remarks>
122+
<exception cref="T:System.InvalidOperationException">This <see cref="T:Windows.UI.Xaml.Media.Animation.RepeatBehavior" /> describes an iteration count, not a repeat duration.</exception>
117123
</Docs>
118124
</Member>
119125
<Member MemberName="Equals">
@@ -141,9 +147,9 @@
141147
<Parameter Name="value" Type="System.Object" />
142148
</Parameters>
143149
<Docs>
144-
<param name="value">To be added.</param>
145-
<summary>To be added.</summary>
146-
<returns>To be added.</returns>
150+
<param name="value">The object to compare with this <see cref="T:Windows.UI.Xaml.Media.Animation.RepeatBehavior" />.</param>
151+
<summary>Indicates whether the specified object is equal to this <see cref="T:Windows.UI.Xaml.Media.Animation.RepeatBehavior" />.</summary>
152+
<returns><see langword="true" /> if <paramref name="value" /> is a <see cref="T:Windows.UI.Xaml.Media.Animation.RepeatBehavior" /> that represents the same repeat behavior as this <see cref="T:Windows.UI.Xaml.Media.Animation.RepeatBehavior" />; otherwise, <see langword="false" />.</returns>
147153
<remarks>To be added.</remarks>
148154
</Docs>
149155
</Member>
@@ -166,9 +172,9 @@
166172
<Parameter Name="repeatBehavior" Type="Windows.UI.Xaml.Media.Animation.RepeatBehavior" />
167173
</Parameters>
168174
<Docs>
169-
<param name="repeatBehavior">To be added.</param>
170-
<summary>To be added.</summary>
171-
<returns>To be added.</returns>
175+
<param name="repeatBehavior">The value to compare to this <see cref="T:Windows.UI.Xaml.Media.Animation.RepeatBehavior" />.</param>
176+
<summary>Returns a value that indicates whether the specified <see cref="T:Windows.UI.Xaml.Media.Animation.RepeatBehavior" /> is equal to this <see cref="T:Windows.UI.Xaml.Media.Animation.RepeatBehavior" />.</summary>
177+
<returns><see langword="true" /> if both the type and repeat behavior of <paramref name="repeatBehavior" /> are equal to this <see cref="T:Windows.UI.Xaml.Media.Animation.RepeatBehavior" />; otherwise, <see langword="false" />.</returns>
172178
<remarks>To be added.</remarks>
173179
</Docs>
174180
</Member>
@@ -193,10 +199,10 @@
193199
<Parameter Name="repeatBehavior2" Type="Windows.UI.Xaml.Media.Animation.RepeatBehavior" />
194200
</Parameters>
195201
<Docs>
196-
<param name="repeatBehavior1">To be added.</param>
197-
<param name="repeatBehavior2">To be added.</param>
198-
<summary>To be added.</summary>
199-
<returns>To be added.</returns>
202+
<param name="repeatBehavior1">The first value to compare.</param>
203+
<param name="repeatBehavior2">The second value to compare.</param>
204+
<summary>Indicates whether the two specified <see cref="T:Windows.UI.Xaml.Media.Animation.RepeatBehavior" /> values are equal.</summary>
205+
<returns><see langword="true" /> if both the type and repeat behavior of <paramref name="repeatBehavior1" /> are equal to that of <paramref name="repeatBehavior2" />; otherwise, <see langword="false" />.</returns>
200206
<remarks>To be added.</remarks>
201207
</Docs>
202208
</Member>
@@ -217,8 +223,8 @@
217223
<ReturnType>Windows.UI.Xaml.Media.Animation.RepeatBehavior</ReturnType>
218224
</ReturnValue>
219225
<Docs>
220-
<summary>To be added.</summary>
221-
<value>To be added.</value>
226+
<summary>Gets a <see cref="T:Windows.UI.Xaml.Media.Animation.RepeatBehavior" /> that specifies an infinite number of repetitions. </summary>
227+
<value>A <see cref="T:Windows.UI.Xaml.Media.Animation.RepeatBehavior" /> that specifies an infinite number of repetitions. </value>
222228
<remarks>To be added.</remarks>
223229
</Docs>
224230
</Member>
@@ -245,8 +251,8 @@
245251
</ReturnValue>
246252
<Parameters />
247253
<Docs>
248-
<summary>To be added.</summary>
249-
<returns>To be added.</returns>
254+
<summary>Returns the hash code of this instance.</summary>
255+
<returns>A hash code.</returns>
250256
<remarks>To be added.</remarks>
251257
</Docs>
252258
</Member>
@@ -267,8 +273,8 @@
267273
<ReturnType>System.Boolean</ReturnType>
268274
</ReturnValue>
269275
<Docs>
270-
<summary>To be added.</summary>
271-
<value>To be added.</value>
276+
<summary>Gets a value that indicates whether the repeat behavior has a specified iteration count.</summary>
277+
<value><see langword="true" /> if the instance represents an iteration count; otherwise, <see langword="false" />.</value>
272278
<remarks>To be added.</remarks>
273279
</Docs>
274280
</Member>
@@ -289,8 +295,8 @@
289295
<ReturnType>System.Boolean</ReturnType>
290296
</ReturnValue>
291297
<Docs>
292-
<summary>To be added.</summary>
293-
<value>To be added.</value>
298+
<summary>Gets a value that indicates whether the repeat behavior has a specified repeat duration.</summary>
299+
<value><see langword="true" /> if the instance represents a repeat duration; otherwise, <see langword="false" />.</value>
294300
<remarks>To be added.</remarks>
295301
</Docs>
296302
</Member>
@@ -315,10 +321,10 @@
315321
<Parameter Name="repeatBehavior2" Type="Windows.UI.Xaml.Media.Animation.RepeatBehavior" />
316322
</Parameters>
317323
<Docs>
318-
<param name="repeatBehavior1">To be added.</param>
319-
<param name="repeatBehavior2">To be added.</param>
320-
<summary>To be added.</summary>
321-
<returns>To be added.</returns>
324+
<param name="repeatBehavior1">The first value to compare.</param>
325+
<param name="repeatBehavior2">The second value to compare.</param>
326+
<summary>Indicates whether the two specified <see cref="T:Windows.UI.Xaml.Media.Animation.RepeatBehavior" /> values are equal.</summary>
327+
<returns><see langword="true" /> if both the type and repeat behavior of <paramref name="repeatBehavior1" /> are equal to that of <paramref name="repeatBehavior2" />; otherwise, <see langword="false" />.</returns>
322328
<remarks>To be added.</remarks>
323329
</Docs>
324330
</Member>
@@ -343,10 +349,10 @@
343349
<Parameter Name="repeatBehavior2" Type="Windows.UI.Xaml.Media.Animation.RepeatBehavior" />
344350
</Parameters>
345351
<Docs>
346-
<param name="repeatBehavior1">To be added.</param>
347-
<param name="repeatBehavior2">To be added.</param>
348-
<summary>To be added.</summary>
349-
<returns>To be added.</returns>
352+
<param name="repeatBehavior1">The first value to compare.</param>
353+
<param name="repeatBehavior2">The second value to compare.</param>
354+
<summary>Indicates whether the two specified <see cref="T:Windows.UI.Xaml.Media.Animation.RepeatBehavior" /> values are not equal.</summary>
355+
<returns><see langword="true" /> if <paramref name="repeatBehavior1" /> and <paramref name="repeatBehavior2" /> are different types or the repeat behavior properties are not equal; otherwise, <see langword="false" />.</returns>
350356
<remarks>To be added.</remarks>
351357
</Docs>
352358
</Member>
@@ -378,10 +384,10 @@
378384
<Parameter Name="formatProvider" Type="System.IFormatProvider" />
379385
</Parameters>
380386
<Docs>
381-
<param name="format">To be added.</param>
382-
<param name="formatProvider">To be added.</param>
383-
<summary>To be added.</summary>
384-
<returns>To be added.</returns>
387+
<param name="format">The string specifying the format to use, or <see langword="null" /> to use the default format defined for the type of the <see cref="T:System.IFormattable" /> implementation.</param>
388+
<param name="formatProvider">An object that provides formatting information for value, or <see langword="null" /> to obtain the numeric format information from the current culture.</param>
389+
<summary>For a description of this member, see <see cref="M:System.IFormattable.ToString(System.String,System.IFormatProvider)" />.</summary>
390+
<returns>A string containing the value of the current instance in the specified format.</returns>
385391
<remarks>To be added.</remarks>
386392
</Docs>
387393
</Member>
@@ -408,8 +414,8 @@
408414
</ReturnValue>
409415
<Parameters />
410416
<Docs>
411-
<summary>To be added.</summary>
412-
<returns>To be added.</returns>
417+
<summary>Returns a string representation of this <see cref="T:Windows.UI.Xaml.Media.Animation.RepeatBehavior" />.</summary>
418+
<returns>A string representation of this <see cref="T:Windows.UI.Xaml.Media.Animation.RepeatBehavior" />.</returns>
413419
<remarks>To be added.</remarks>
414420
</Docs>
415421
</Member>
@@ -433,9 +439,9 @@
433439
<Parameter Name="formatProvider" Type="System.IFormatProvider" />
434440
</Parameters>
435441
<Docs>
436-
<param name="formatProvider">To be added.</param>
437-
<summary>To be added.</summary>
438-
<returns>To be added.</returns>
442+
<param name="formatProvider">The format used to construct the return value.</param>
443+
<summary>Returns a string representation of this <see cref="T:Windows.UI.Xaml.Media.Animation.RepeatBehavior" /> with the specified format.</summary>
444+
<returns>A string representation of this <see cref="T:Windows.UI.Xaml.Media.Animation.RepeatBehavior" />.</returns>
439445
<remarks>To be added.</remarks>
440446
</Docs>
441447
</Member>
@@ -456,10 +462,10 @@
456462
<ReturnType>Windows.UI.Xaml.Media.Animation.RepeatBehaviorType</ReturnType>
457463
</ReturnValue>
458464
<Docs>
459-
<summary>To be added.</summary>
460-
<value>To be added.</value>
465+
<summary>Gets or sets one of the <see cref="T:Windows.UI.Xaml.Media.Animation.RepeatBehaviorType" /> values that describes the way behavior repeats.</summary>
466+
<value>The type of repeat behavior.</value>
461467
<remarks>To be added.</remarks>
462468
</Docs>
463469
</Member>
464470
</Members>
465-
</Type>
471+
</Type>

0 commit comments

Comments
 (0)