Skip to content

Commit ac33a42

Browse files
jwmsftjwmsft
committed
Add namespace descriptions, class remarks
1 parent 3ceaa56 commit ac33a42

12 files changed

+506
-93
lines changed

‎xml/Windows.Foundation/Point.xml‎

Lines changed: 102 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,19 @@
2525
</Attributes>
2626
<Docs>
2727
<summary>Represents an x- and y-coordinate pair in two-dimensional space. Can also represent a logical point for certain property usages.</summary>
28-
<remarks>To be added.</remarks>
28+
<remarks>
29+
<format type="text/markdown"><![CDATA[
30+
31+
## Remarks
32+
This represents the .NET projection of the Windows Runtime (WinRT) **Point** type. For more info, see [Point](https://docs.microsoft.com/uwp/api/windows.foundation.point) in the UWP API reference.
33+
34+
Additional reference:
35+
36+
- [Point](https://docs.microsoft.com/uwp/api/windows.foundation.point) (UWP)
37+
- [System.Windows.Point](https://docs.microsoft.com/dotnet/api/system.windows.point?view=netframework-4.8) (.NET Framwwork)
38+
39+
]]></format>
40+
</remarks>
2941
</Docs>
3042
<Members>
3143
<Member MemberName=".ctor">
@@ -49,7 +61,14 @@
4961
<param name="x">The x-coordinate value of the <see cref="T:Windows.Foundation.Point" /> struct. </param>
5062
<param name="y">The y-coordinate value of the <see cref="T:Windows.Foundation.Point" /> struct. </param>
5163
<summary>Initializes a <see cref="T:Windows.Foundation.Point" /> struct that contains the specified values.</summary>
52-
<remarks>To be added.</remarks>
64+
<remarks>
65+
<format type="text/markdown"><![CDATA[
66+
67+
## Remarks
68+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **Point** Struct. For more info, see [Point](https://docs.microsoft.com/uwp/api/windows.foundation.point) in the UWP API reference.
69+
70+
]]></format>
71+
</remarks>
5372
</Docs>
5473
</Member>
5574
<Member MemberName="Equals">
@@ -79,9 +98,17 @@
7998
<Docs>
8099
<param name="o">The object to compare.</param>
81100
<summary>Determines whether the specified object is a <see cref="T:Windows.Foundation.Point" /> and whether it contains the same values as this <see cref="T:Windows.Foundation.Point" />.</summary>
82-
<returns>
83-
<see langword="true" /> if <paramref name="obj" /> is a <see cref="T:Windows.Foundation.Point" /> and contains the same <see cref="P:Windows.Foundation.Point.X" /> and <see cref="P:Windows.Foundation.Point.Y" /> values as this <see cref="T:Windows.Foundation.Point" />; otherwise, <see langword="false" />.</returns>
84-
<remarks>To be added.</remarks>
101+
<returns><see langword="true" /> if <paramref name="obj" /> is a <see cref="T:Windows.Foundation.Point" /> and contains the same <see cref="P:Windows.Foundation.Point.X" /> and <see cref="P:Windows.Foundation.Point.Y" /> values as this <see cref="T:Windows.Foundation.Point" />; otherwise, <see langword="false" />.</returns>
102+
<remarks>
103+
<format type="text/markdown"><![CDATA[
104+
105+
## Remarks
106+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **Point** Struct. For more info, see [Point](https://docs.microsoft.com/uwp/api/windows.foundation.point) in the UWP API reference.
107+
108+
For more info and examples of this member, see [System.Windows.Point.Equals](https://docs.microsoft.com/dotnet/api/system.windows.point.equals?view=netframework-4.8) in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.)
109+
110+
]]></format>
111+
</remarks>
85112
</Docs>
86113
</Member>
87114
<Member MemberName="Equals">
@@ -106,8 +133,7 @@
106133
<Docs>
107134
<param name="value">The point to compare to this instance.</param>
108135
<summary>Compares two <see cref="T:Windows.Foundation.Point" /> structs for equality.</summary>
109-
<returns>
110-
<see langword="true" /> if both <see cref="T:Windows.Foundation.Point" /> structs contain the same <see cref="P:Windows.Foundation.Point.X" /> and <see cref="P:Windows.Foundation.Point.Y" /> values; otherwise, <see langword="false" />.</returns>
136+
<returns><see langword="true" /> if both <see cref="T:Windows.Foundation.Point" /> structs contain the same <see cref="P:Windows.Foundation.Point.X" /> and <see cref="P:Windows.Foundation.Point.Y" /> values; otherwise, <see langword="false" />.</returns>
111137
<remarks>To be added.</remarks>
112138
</Docs>
113139
</Member>
@@ -136,7 +162,16 @@
136162
<Docs>
137163
<summary>Returns the hash code for this <see cref="T:Windows.Foundation.Point" />.</summary>
138164
<returns>The hash code for this <see cref="T:Windows.Foundation.Point" /> struct.</returns>
139-
<remarks>To be added.</remarks>
165+
<remarks>
166+
<format type="text/markdown"><![CDATA[
167+
168+
## Remarks
169+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **Point** Struct. For more info, see [Point](https://docs.microsoft.com/uwp/api/windows.foundation.point) in the UWP API reference.
170+
171+
For more info and examples of this member, see [System.Windows.Point.GetHashCode](https://docs.microsoft.com/dotnet/api/system.windows.point.gethashcode?view=netframework-4.8) in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.)
172+
173+
]]></format>
174+
</remarks>
140175
</Docs>
141176
</Member>
142177
<Member MemberName="op_Equality">
@@ -163,9 +198,17 @@
163198
<param name="point1">The first <see cref="T:Windows.Foundation.Point" /> struct to compare.</param>
164199
<param name="point2">The second <see cref="T:Windows.Foundation.Point" /> struct to compare.</param>
165200
<summary>Compares two <see cref="T:Windows.Foundation.Point" /> structs for equality.</summary>
166-
<returns>
167-
<see langword="true" /> if both the <see cref="P:Windows.Foundation.Point.X" /> and <see cref="P:Windows.Foundation.Point.Y" /> values of <paramref name="point1" /> and <paramref name="point2" /> are equal; otherwise, <see langword="false" />.</returns>
168-
<remarks>To be added.</remarks>
201+
<returns><see langword="true" /> if both the <see cref="P:Windows.Foundation.Point.X" /> and <see cref="P:Windows.Foundation.Point.Y" /> values of <paramref name="point1" /> and <paramref name="point2" /> are equal; otherwise, <see langword="false" />.</returns>
202+
<remarks>
203+
<format type="text/markdown"><![CDATA[
204+
205+
## Remarks
206+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **Point** Struct. For more info, see [Point](https://docs.microsoft.com/uwp/api/windows.foundation.point) in the UWP API reference.
207+
208+
For more info and examples of this member, see [System.Windows.Point.Equality](https://docs.microsoft.com/dotnet/api/system.windows.point.op_equality?view=netframework-4.8) in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.)
209+
210+
]]></format>
211+
</remarks>
169212
</Docs>
170213
</Member>
171214
<Member MemberName="op_Inequality">
@@ -192,9 +235,17 @@
192235
<param name="point1">The first point to compare.</param>
193236
<param name="point2">The second point to compare.</param>
194237
<summary>Compares two <see cref="T:Windows.Foundation.Point" /> structs for inequality</summary>
195-
<returns>
196-
<see langword="true" /> if <paramref name="point1" /> and <paramref name="point2" /> have different <see cref="P:Windows.Foundation.Point.X" /> or <see cref="P:Windows.Foundation.Point.Y" /> values; false if <paramref name="point1" /> and <paramref name="point2" /> have the same <see cref="P:Windows.Foundation.Point.X" /> and <see cref="P:Windows.Foundation.Point.Y" /> values.</returns>
197-
<remarks>To be added.</remarks>
238+
<returns><see langword="true" /> if <paramref name="point1" /> and <paramref name="point2" /> have different <see cref="P:Windows.Foundation.Point.X" /> or <see cref="P:Windows.Foundation.Point.Y" /> values; false if <paramref name="point1" /> and <paramref name="point2" /> have the same <see cref="P:Windows.Foundation.Point.X" /> and <see cref="P:Windows.Foundation.Point.Y" /> values.</returns>
239+
<remarks>
240+
<format type="text/markdown"><![CDATA[
241+
242+
## Remarks
243+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **Point** Struct. For more info, see [Point](https://docs.microsoft.com/uwp/api/windows.foundation.point) in the UWP API reference.
244+
245+
For more info and examples of this member, see [System.Windows.Point.Inequality](https://docs.microsoft.com/dotnet/api/system.windows.point.op_inequality?view=netframework-4.8) in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.)
246+
247+
]]></format>
248+
</remarks>
198249
</Docs>
199250
</Member>
200251
<Member MemberName="System.IFormattable.ToString">
@@ -229,7 +280,14 @@
229280
<param name="provider">An object that provides formatting information for the value, or <see langword="null" /> to obtain the numeric format information from the current culture.</param>
230281
<summary>For a description of this member, see <see cref="M:System.IFormattable.ToString(System.String,System.IFormatProvider)" />.</summary>
231282
<returns>A string containing the value of the current instance in the specified format.</returns>
232-
<remarks>To be added.</remarks>
283+
<remarks>
284+
<format type="text/markdown"><![CDATA[
285+
286+
## Remarks
287+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **Point** Struct. For more info, see [Point](https://docs.microsoft.com/uwp/api/windows.foundation.point) in the UWP API reference.
288+
289+
]]></format>
290+
</remarks>
233291
</Docs>
234292
</Member>
235293
<Member MemberName="ToString">
@@ -257,7 +315,14 @@
257315
<Docs>
258316
<summary>Creates a <see cref="T:System.String" /> representation of this <see cref="T:Windows.Foundation.Point" />.</summary>
259317
<returns>A <see cref="T:System.String" /> containing the <see cref="P:Windows.Foundation.Point.X" /> and <see cref="P:Windows.Foundation.Point.Y" /> values of this <see cref="T:Windows.Foundation.Point" /> struct.</returns>
260-
<remarks>To be added.</remarks>
318+
<remarks>
319+
<format type="text/markdown"><![CDATA[
320+
321+
## Remarks
322+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **Point** Struct. For more info, see [Point](https://docs.microsoft.com/uwp/api/windows.foundation.point) in the UWP API reference.
323+
324+
]]></format>
325+
</remarks>
261326
</Docs>
262327
</Member>
263328
<Member MemberName="ToString">
@@ -305,7 +370,16 @@
305370
<Docs>
306371
<summary>Gets or sets the <see cref="P:Windows.Foundation.Point.X" />-coordinate value of this <see cref="T:Windows.Foundation.Point" /> struct.</summary>
307372
<value>The <see cref="P:Windows.Foundation.Point.X" />-coordinate value of this <see cref="T:Windows.Foundation.Point" /> struct. The default value is 0.</value>
308-
<remarks>To be added.</remarks>
373+
<remarks>
374+
<format type="text/markdown"><![CDATA[
375+
376+
## Remarks
377+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **Point** Struct. For more info, see [Point](https://docs.microsoft.com/uwp/api/windows.foundation.point) in the UWP API reference.
378+
379+
For more info and examples of this member, see [System.Windows.Point.X](https://docs.microsoft.com/dotnet/api/system.windows.point.x?view=netframework-4.8) in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.)
380+
381+
]]></format>
382+
</remarks>
309383
</Docs>
310384
</Member>
311385
<Member MemberName="Y">
@@ -327,8 +401,17 @@
327401
<Docs>
328402
<summary>Gets or sets the <see cref="P:Windows.Foundation.Point.Y" />-coordinate value of this <see cref="T:Windows.Foundation.Point" />.</summary>
329403
<value>The <see cref="P:Windows.Foundation.Point.Y" />-coordinate value of this <see cref="T:Windows.Foundation.Point" /> struct. The default value is 0.</value>
330-
<remarks>To be added.</remarks>
404+
<remarks>
405+
<format type="text/markdown"><![CDATA[
406+
407+
## Remarks
408+
This Struct represents the .NET projection of the Windows Runtime (WinRT) **Point** Struct. For more info, see [Point](https://docs.microsoft.com/uwp/api/windows.foundation.point) in the UWP API reference.
409+
410+
For more info and examples of this member, see [System.Windows.Point.Y](https://docs.microsoft.com/dotnet/api/system.windows.point.y?view=netframework-4.8) in the .NET Framework API reference. (Examples show WPF usage and might not translate directly to UWP XAML.)
411+
412+
]]></format>
413+
</remarks>
331414
</Docs>
332415
</Member>
333416
</Members>
334-
</Type>
417+
</Type>

0 commit comments

Comments
 (0)