Skip to content

Commit d3c6cf1

Browse files
jwmsftjwmsft
committed
Add remarks
1 parent ac33a42 commit d3c6cf1

File tree

13 files changed

+1263
-150
lines changed

13 files changed

+1263
-150
lines changed

‎xml/Windows.UI.Xaml.Controls.Primitives/GeneratorPosition.xml‎

Lines changed: 81 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,19 @@
2121
</Attributes>
2222
<Docs>
2323
<summary>Describes the position of an item that is managed by <see cref="T:Windows.UI.Xaml.Controls.ItemContainerGenerator" />.</summary>
24-
<remarks>To be added.</remarks>
24+
<remarks>
25+
<format type="text/markdown"><![CDATA[
26+
27+
## Remarks
28+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **GeneratorPosition** Struct. For more info, see [GeneratorPosition](https://docs.microsoft.com/uwp/api/windows.ui.xaml.controls.primitives.generatorposition) in the UWP API reference.
29+
30+
Additional reference:
31+
32+
- [GeneratorPosition](https://docs.microsoft.com/uwp/api/windows.ui.xaml.controls.primitives.generatorposition) (UWP)
33+
- [System.Windows.Controls.Primitives.GeneratorPosition](https://docs.microsoft.com/dotnet/api/system.windows.controls.primitives.generatorposition?view=netframework-4.8) (.NET Framwwork)
34+
35+
]]></format>
36+
</remarks>
2537
</Docs>
2638
<Members>
2739
<Member MemberName=".ctor">
@@ -45,7 +57,14 @@
4557
<param name="index">An index that is relative to the generated (realized) items. -1 is a special value that refers to a fictitious item at the beginning or the end of the items list.</param>
4658
<param name="offset">An offset that is relative to the ungenerated (unrealized) items near the indexed item. An offset of 0 refers to the indexed element itself, an offset of 1 refers to the next ungenerated (unrealized) item, and an offset of -1 refers to the previous item.</param>
4759
<summary>Initializes a new instance of <see cref="T:Windows.UI.Xaml.Controls.Primitives.GeneratorPosition" /> with the specified index and offset.</summary>
48-
<remarks>To be added.</remarks>
60+
<remarks>
61+
<format type="text/markdown"><![CDATA[
62+
63+
## Remarks
64+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **GeneratorPosition** Struct. For more info, see [GeneratorPosition](https://docs.microsoft.com/uwp/api/windows.ui.xaml.controls.primitives.generatorposition) in the UWP API reference.
65+
66+
]]></format>
67+
</remarks>
4968
</Docs>
5069
</Member>
5170
<Member MemberName="Equals">
@@ -77,7 +96,14 @@
7796
<summary>Compares the specified instance and the current instance of <see cref="T:Windows.UI.Xaml.Controls.Primitives.GeneratorPosition" /> for value equality.</summary>
7897
<returns>
7998
<see langword="true" /> if <paramref name="o" /> and this instance of <see cref="T:Windows.UI.Xaml.Controls.Primitives.GeneratorPosition" /> have the same values.</returns>
80-
<remarks>To be added.</remarks>
99+
<remarks>
100+
<format type="text/markdown"><![CDATA[
101+
102+
## Remarks
103+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **GeneratorPosition** Struct. For more info, see [GeneratorPosition](https://docs.microsoft.com/uwp/api/windows.ui.xaml.controls.primitives.generatorposition) in the UWP API reference.
104+
105+
]]></format>
106+
</remarks>
81107
</Docs>
82108
</Member>
83109
<Member MemberName="GetHashCode">
@@ -105,7 +131,14 @@
105131
<Docs>
106132
<summary>Returns the hash code for this <see cref="T:Windows.UI.Xaml.Controls.Primitives.GeneratorPosition" />.</summary>
107133
<returns>The hash code for this <see cref="T:Windows.UI.Xaml.Controls.Primitives.GeneratorPosition" />.</returns>
108-
<remarks>To be added.</remarks>
134+
<remarks>
135+
<format type="text/markdown"><![CDATA[
136+
137+
## Remarks
138+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **GeneratorPosition** Struct. For more info, see [GeneratorPosition](https://docs.microsoft.com/uwp/api/windows.ui.xaml.controls.primitives.generatorposition) in the UWP API reference.
139+
140+
]]></format>
141+
</remarks>
109142
</Docs>
110143
</Member>
111144
<Member MemberName="Index">
@@ -127,7 +160,16 @@
127160
<Docs>
128161
<summary>Gets or sets the index that is relative to the generated (realized) items.</summary>
129162
<value>The index that is relative to the generated (realized) items.</value>
130-
<remarks>To be added.</remarks>
163+
<remarks>
164+
<format type="text/markdown"><![CDATA[
165+
166+
## Remarks
167+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **GeneratorPosition** Struct. For more info, see [GeneratorPosition](https://docs.microsoft.com/uwp/api/windows.ui.xaml.controls.primitives.generatorposition) in the UWP API reference.
168+
169+
**-1** is a special value that refers to a fictitious item at the beginning or the end of the items list.
170+
171+
]]></format>
172+
</remarks>
131173
</Docs>
132174
</Member>
133175
<Member MemberName="Offset">
@@ -149,7 +191,16 @@
149191
<Docs>
150192
<summary>Gets or sets the offset that is relative to the ungenerated (unrealized) items near the indexed item.</summary>
151193
<value>The offset that is relative to the ungenerated (unrealized) items near the indexed item.</value>
152-
<remarks>To be added.</remarks>
194+
<remarks>
195+
<format type="text/markdown"><![CDATA[
196+
197+
## Remarks
198+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **GeneratorPosition** Struct. For more info, see [GeneratorPosition](https://docs.microsoft.com/uwp/api/windows.ui.xaml.controls.primitives.generatorposition) in the UWP API reference.
199+
200+
An offset of **0** refers to the indexed element itself, an offset **1** refers to the next ungenerated (unrealized) item, and an offset of **-1** refers to the previous item.
201+
202+
]]></format>
203+
</remarks>
153204
</Docs>
154205
</Member>
155206
<Member MemberName="op_Equality">
@@ -178,7 +229,14 @@
178229
<summary>Compares two <see cref="T:Windows.UI.Xaml.Controls.Primitives.GeneratorPosition" /> objects for value equality.</summary>
179230
<returns>
180231
<see langword="true" /> if the two objects are equal; otherwise, <see langword="false" />.</returns>
181-
<remarks>To be added.</remarks>
232+
<remarks>
233+
<format type="text/markdown"><![CDATA[
234+
235+
## Remarks
236+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **GeneratorPosition** Struct. For more info, see [GeneratorPosition](https://docs.microsoft.com/uwp/api/windows.ui.xaml.controls.primitives.generatorposition) in the UWP API reference.
237+
238+
]]></format>
239+
</remarks>
182240
</Docs>
183241
</Member>
184242
<Member MemberName="op_Inequality">
@@ -207,7 +265,14 @@
207265
<summary>Compares two <see cref="T:Windows.UI.Xaml.Controls.Primitives.GeneratorPosition" /> objects for value inequality.</summary>
208266
<returns>
209267
<see langword="true" /> if the values are not equal; otherwise, <see langword="false" />.</returns>
210-
<remarks>To be added.</remarks>
268+
<remarks>
269+
<format type="text/markdown"><![CDATA[
270+
271+
## Remarks
272+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **GeneratorPosition** Struct. For more info, see [GeneratorPosition](https://docs.microsoft.com/uwp/api/windows.ui.xaml.controls.primitives.generatorposition) in the UWP API reference.
273+
274+
]]></format>
275+
</remarks>
211276
</Docs>
212277
</Member>
213278
<Member MemberName="ToString">
@@ -235,7 +300,14 @@
235300
<Docs>
236301
<summary>Returns a string representation of this instance of <see cref="T:Windows.UI.Xaml.Controls.Primitives.GeneratorPosition" />.</summary>
237302
<returns>A string representation of this instance of <see cref="T:Windows.UI.Xaml.Controls.Primitives.GeneratorPosition" />.</returns>
238-
<remarks>To be added.</remarks>
303+
<remarks>
304+
<format type="text/markdown"><![CDATA[
305+
306+
## Remarks
307+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **GeneratorPosition** Struct. For more info, see [GeneratorPosition](https://docs.microsoft.com/uwp/api/windows.ui.xaml.controls.primitives.generatorposition) in the UWP API reference.
308+
309+
]]></format>
310+
</remarks>
239311
</Docs>
240312
</Member>
241313
</Members>

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

Lines changed: 77 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,19 @@
2121
</Attributes>
2222
<Docs>
2323
<summary>Specifies when a particular key frame should take place during an animation. </summary>
24-
<remarks>To be added.</remarks>
24+
<remarks>
25+
<format type="text/markdown"><![CDATA[
26+
27+
## Remarks
28+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **KeyTime** Struct. For more info, see [KeyTime](https://docs.microsoft.com/uwp/api/windows.ui.xaml.media.animation.keytime) in the UWP API reference.
29+
30+
Additional reference:
31+
32+
- [KeyTime](https://docs.microsoft.com/uwp/api/windows.ui.xaml.media.animation.keytime) (UWP)
33+
- [System.Windows.Media.KeyTime](https://docs.microsoft.com/dotnet/api/system.windows.media.animation.keytime?view=netframework-4.8) (.NET Framwwork)
34+
35+
]]></format>
36+
</remarks>
2537
</Docs>
2638
<Members>
2739
<Member MemberName="Equals">
@@ -53,7 +65,14 @@
5365
<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>
5466
<returns>
5567
<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>
56-
<remarks>To be added.</remarks>
68+
<remarks>
69+
<format type="text/markdown"><![CDATA[
70+
71+
## Remarks
72+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **KeyTime** Struct. For more info, see [KeyTime](https://docs.microsoft.com/uwp/api/windows.ui.xaml.media.animation.keytime) in the UWP API reference.
73+
74+
]]></format>
75+
</remarks>
5776
</Docs>
5877
</Member>
5978
<Member MemberName="Equals">
@@ -134,7 +153,14 @@
134153
<param name="timeSpan">The value of the new <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" />.</param>
135154
<summary>Creates a new <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" />, using the supplied <see cref="T:System.TimeSpan" />.</summary>
136155
<returns>A new <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" />, initialized to the value of <paramref name="timeSpan" />.</returns>
137-
<remarks>To be added.</remarks>
156+
<remarks>
157+
<format type="text/markdown"><![CDATA[
158+
159+
## Remarks
160+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **KeyTime** Struct. For more info, see [KeyTime](https://docs.microsoft.com/uwp/api/windows.ui.xaml.media.animation.keytime) in the UWP API reference.
161+
162+
]]></format>
163+
</remarks>
138164
<exception cref="T:System.ArgumentOutOfRangeException">The specified <paramref name="timeSpan" /> is outside the allowed range.</exception>
139165
</Docs>
140166
</Member>
@@ -163,7 +189,14 @@
163189
<Docs>
164190
<summary>Returns a hash code representing this <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" />.</summary>
165191
<returns>A hash code.</returns>
166-
<remarks>To be added.</remarks>
192+
<remarks>
193+
<format type="text/markdown"><![CDATA[
194+
195+
## Remarks
196+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **KeyTime** Struct. For more info, see [KeyTime](https://docs.microsoft.com/uwp/api/windows.ui.xaml.media.animation.keytime) in the UWP API reference.
197+
198+
]]></format>
199+
</remarks>
167200
</Docs>
168201
</Member>
169202
<Member MemberName="op_Equality">
@@ -192,7 +225,14 @@
192225
<summary>Compares two <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" /> values for equality.</summary>
193226
<returns>
194227
<see langword="true" /> if <paramref name="keyTime1" /> and <paramref name="keyTime2" /> are equal; otherwise, <see langword="false" />.</returns>
195-
<remarks>To be added.</remarks>
228+
<remarks>
229+
<format type="text/markdown"><![CDATA[
230+
231+
## Remarks
232+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **KeyTime** Struct. For more info, see [KeyTime](https://docs.microsoft.com/uwp/api/windows.ui.xaml.media.animation.keytime) in the UWP API reference.
233+
234+
]]></format>
235+
</remarks>
196236
</Docs>
197237
</Member>
198238
<Member MemberName="op_Implicit">
@@ -217,7 +257,14 @@
217257
<param name="timeSpan">The <see cref="P:Windows.UI.Xaml.Media.Animation.KeyTime.TimeSpan" /> value to convert.</param>
218258
<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>
219259
<returns>The created <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" />.</returns>
220-
<remarks>To be added.</remarks>
260+
<remarks>
261+
<format type="text/markdown"><![CDATA[
262+
263+
## Remarks
264+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **KeyTime** Struct. For more info, see [KeyTime](https://docs.microsoft.com/uwp/api/windows.ui.xaml.media.animation.keytime) in the UWP API reference.
265+
266+
]]></format>
267+
</remarks>
221268
</Docs>
222269
</Member>
223270
<Member MemberName="op_Inequality">
@@ -246,7 +293,14 @@
246293
<summary>Compares two <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" /> values for inequality.</summary>
247294
<returns>
248295
<see langword="true" /> if <paramref name="keyTime1" /> and <paramref name="keyTime2" /> are not equal; otherwise, false. </returns>
249-
<remarks>To be added.</remarks>
296+
<remarks>
297+
<format type="text/markdown"><![CDATA[
298+
299+
## Remarks
300+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **KeyTime** Struct. For more info, see [KeyTime](https://docs.microsoft.com/uwp/api/windows.ui.xaml.media.animation.keytime) in the UWP API reference.
301+
302+
]]></format>
303+
</remarks>
250304
</Docs>
251305
</Member>
252306
<Member MemberName="TimeSpan">
@@ -268,7 +322,14 @@
268322
<Docs>
269323
<summary>Gets the time when the key frame ends, expressed as a time relative to the beginning of the animation.</summary>
270324
<value>The time when the key frame ends, expressed as a time relative to the beginning of the animation.</value>
271-
<remarks>To be added.</remarks>
325+
<remarks>
326+
<format type="text/markdown"><![CDATA[
327+
328+
## Remarks
329+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **KeyTime** Struct. For more info, see [KeyTime](https://docs.microsoft.com/uwp/api/windows.ui.xaml.media.animation.keytime) in the UWP API reference.
330+
331+
]]></format>
332+
</remarks>
272333
</Docs>
273334
</Member>
274335
<Member MemberName="ToString">
@@ -296,7 +357,14 @@
296357
<Docs>
297358
<summary>Returns a string representation of this <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" />. </summary>
298359
<returns>A string representation of this <see cref="T:Windows.UI.Xaml.Media.Animation.KeyTime" />.</returns>
299-
<remarks>To be added.</remarks>
360+
<remarks>
361+
<format type="text/markdown"><![CDATA[
362+
363+
## Remarks
364+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **KeyTime** Struct. For more info, see [KeyTime](https://docs.microsoft.com/uwp/api/windows.ui.xaml.media.animation.keytime) in the UWP API reference.
365+
366+
]]></format>
367+
</remarks>
300368
</Docs>
301369
</Member>
302370
</Members>

0 commit comments

Comments
 (0)