Skip to content

Commit a927f1a

Browse files
tannergoodingtannergooding
authored
Updating the documentation for System.Numerics (#10292)
1 parent 409b2f1 commit a927f1a

File tree

8 files changed

+188
-40
lines changed

8 files changed

+188
-40
lines changed

‎xml/System.Numerics/TotalOrderIeee754Comparer`1.xml‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -154,9 +154,10 @@
154154
</Parameter>
155155
</Parameters>
156156
<Docs>
157-
<param name="obj">To be added.</param>
158-
<summary>To be added.</summary>
159-
<returns>To be added.</returns>
157+
<param name="obj">The object to compare with the current instance.</param>
158+
<summary>Determines whether this instance and a specified object are equal.</summary>
159+
<returns>
160+
<see langword="true" /> if the current instance and <paramref name="obj" /> are equal; otherwise, <see langword="false" />. If <paramref name="obj" /> is <see langword="null" />, the method returns <see langword="false" />.</returns>
160161
<remarks>To be added.</remarks>
161162
</Docs>
162163
</Member>
@@ -211,8 +212,8 @@
211212
</ReturnValue>
212213
<Parameters />
213214
<Docs>
214-
<summary>To be added.</summary>
215-
<returns>To be added.</returns>
215+
<summary>Returns the hash code for this instance.</summary>
216+
<returns>The hash code.</returns>
216217
<remarks>To be added.</remarks>
217218
</Docs>
218219
</Member>

‎xml/System.Numerics/Vector.xml‎

Lines changed: 56 additions & 10 deletions
Large diffs are not rendered by default.

‎xml/System.Numerics/Vector2.xml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -332,6 +332,7 @@
332332
<summary>Restricts a vector between a minimum and a maximum value.</summary>
333333
<returns>The restricted vector.</returns>
334334
<remarks>To be added.</remarks>
335+
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.Clamp(`0,`0,`0)" />
335336
</Docs>
336337
</Member>
337338
<Member MemberName="ClampNative">
@@ -367,6 +368,7 @@
367368
<summary>To be added.</summary>
368369
<returns>To be added.</returns>
369370
<remarks>To be added.</remarks>
371+
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.ClampNative(`0,`0,`0)" />
370372
</Docs>
371373
</Member>
372374
<Member MemberName="CopySign">
@@ -400,6 +402,7 @@
400402
<summary>To be added.</summary>
401403
<returns>To be added.</returns>
402404
<remarks>To be added.</remarks>
405+
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.CopySign(`0,`0)" />
403406
</Docs>
404407
</Member>
405408
<MemberGroup MemberName="CopyTo">
@@ -630,6 +633,7 @@
630633
<summary>To be added.</summary>
631634
<returns>To be added.</returns>
632635
<remarks>To be added.</remarks>
636+
<inheritdoc cref="M:System.Numerics.Vector4.Cos(System.Numerics.Vector4)" />
633637
</Docs>
634638
</Member>
635639
<Member MemberName="Create">
@@ -756,6 +760,7 @@
756760
<summary>To be added.</summary>
757761
<returns>To be added.</returns>
758762
<remarks>To be added.</remarks>
763+
<inheritdoc cref="M:System.Numerics.Vector4.DegreesToRadians(System.Numerics.Vector4)" />
759764
</Docs>
760765
</Member>
761766
<Member MemberName="Distance">
@@ -1034,6 +1039,7 @@
10341039
<summary>To be added.</summary>
10351040
<value>To be added.</value>
10361041
<remarks>To be added.</remarks>
1042+
<inheritdoc cref="P:System.Numerics.Vector4.E" />
10371043
</Docs>
10381044
</Member>
10391045
<Member MemberName="Epsilon">
@@ -1061,6 +1067,7 @@
10611067
<summary>To be added.</summary>
10621068
<value>To be added.</value>
10631069
<remarks>To be added.</remarks>
1070+
<inheritdoc cref="P:System.Numerics.Vector4.Epsilon" />
10641071
</Docs>
10651072
</Member>
10661073
<MemberGroup MemberName="Equals">
@@ -1240,6 +1247,7 @@
12401247
<summary>To be added.</summary>
12411248
<returns>To be added.</returns>
12421249
<remarks>To be added.</remarks>
1250+
<inheritdoc cref="M:System.Numerics.Vector4.Exp(System.Numerics.Vector4)" />
12431251
</Docs>
12441252
</Member>
12451253
<Member MemberName="FusedMultiplyAdd">
@@ -1359,6 +1367,7 @@
13591367
<summary>To be added.</summary>
13601368
<returns>To be added.</returns>
13611369
<remarks>To be added.</remarks>
1370+
<inheritdoc cref="M:System.Numerics.Vector4.Hypot(System.Numerics.Vector4,System.Numerics.Vector4)" />
13621371
</Docs>
13631372
</Member>
13641373
<Member MemberName="Item">
@@ -1544,6 +1553,7 @@
15441553
<summary>To be added.</summary>
15451554
<returns>To be added.</returns>
15461555
<remarks>To be added.</remarks>
1556+
<inheritdoc cref="M:System.Numerics.Vector4.Lerp(System.Numerics.Vector4,System.Numerics.Vector4,System.Numerics.Vector4)" />
15471557
</Docs>
15481558
</Member>
15491559
<Member MemberName="Lerp">
@@ -1602,6 +1612,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
16021612
16031613
]]></format>
16041614
</remarks>
1615+
<inheritdoc cref="M:System.Numerics.Vector4.Lerp(System.Numerics.Vector4,System.Numerics.Vector4,System.Single)" />
16051616
</Docs>
16061617
</Member>
16071618
<Member MemberName="Log">
@@ -1633,6 +1644,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
16331644
<summary>To be added.</summary>
16341645
<returns>To be added.</returns>
16351646
<remarks>To be added.</remarks>
1647+
<inheritdoc cref="M:System.Numerics.Vector4.Log2(System.Numerics.Vector4)" />
16361648
</Docs>
16371649
</Member>
16381650
<Member MemberName="Log2">
@@ -1664,6 +1676,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
16641676
<summary>To be added.</summary>
16651677
<returns>To be added.</returns>
16661678
<remarks>To be added.</remarks>
1679+
<inheritdoc cref="M:System.Numerics.Vector4.Log(System.Numerics.Vector4)" />
16671680
</Docs>
16681681
</Member>
16691682
<Member MemberName="Max">
@@ -1712,6 +1725,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
17121725
<summary>Returns a vector whose elements are the maximum of each of the pairs of elements in two specified vectors.</summary>
17131726
<returns>The maximized vector.</returns>
17141727
<remarks>To be added.</remarks>
1728+
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.Max(`0,`0)" />
17151729
</Docs>
17161730
</Member>
17171731
<Member MemberName="MaxMagnitude">
@@ -1745,6 +1759,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
17451759
<summary>To be added.</summary>
17461760
<returns>To be added.</returns>
17471761
<remarks>To be added.</remarks>
1762+
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MaxMagnitude(`0,`0)" />
17481763
</Docs>
17491764
</Member>
17501765
<Member MemberName="MaxMagnitudeNumber">
@@ -1778,6 +1793,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
17781793
<summary>To be added.</summary>
17791794
<returns>To be added.</returns>
17801795
<remarks>To be added.</remarks>
1796+
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MaxMagnitudeNumber(`0,`0)" />
17811797
</Docs>
17821798
</Member>
17831799
<Member MemberName="MaxNative">
@@ -1811,6 +1827,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
18111827
<summary>To be added.</summary>
18121828
<returns>To be added.</returns>
18131829
<remarks>To be added.</remarks>
1830+
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MaxNative(`0,`0)" />
18141831
</Docs>
18151832
</Member>
18161833
<Member MemberName="MaxNumber">
@@ -1844,6 +1861,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
18441861
<summary>To be added.</summary>
18451862
<returns>To be added.</returns>
18461863
<remarks>To be added.</remarks>
1864+
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MaxNumber(`0,`0)" />
18471865
</Docs>
18481866
</Member>
18491867
<Member MemberName="Min">
@@ -1892,6 +1910,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
18921910
<summary>Returns a vector whose elements are the minimum of each of the pairs of elements in two specified vectors.</summary>
18931911
<returns>The minimized vector.</returns>
18941912
<remarks>To be added.</remarks>
1913+
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.Min(`0,`0)" />
18951914
</Docs>
18961915
</Member>
18971916
<Member MemberName="MinMagnitude">
@@ -1925,6 +1944,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
19251944
<summary>To be added.</summary>
19261945
<returns>To be added.</returns>
19271946
<remarks>To be added.</remarks>
1947+
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MinMagnitude(`0,`0)" />
19281948
</Docs>
19291949
</Member>
19301950
<Member MemberName="MinMagnitudeNumber">
@@ -1958,6 +1978,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
19581978
<summary>To be added.</summary>
19591979
<returns>To be added.</returns>
19601980
<remarks>To be added.</remarks>
1981+
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MinMagnitudeNumber(`0,`0)" />
19611982
</Docs>
19621983
</Member>
19631984
<Member MemberName="MinNative">
@@ -1991,6 +2012,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
19912012
<summary>To be added.</summary>
19922013
<returns>To be added.</returns>
19932014
<remarks>To be added.</remarks>
2015+
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MinNative(`0,`0)" />
19942016
</Docs>
19952017
</Member>
19962018
<Member MemberName="MinNumber">
@@ -2024,6 +2046,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
20242046
<summary>To be added.</summary>
20252047
<returns>To be added.</returns>
20262048
<remarks>To be added.</remarks>
2049+
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MinNumber(`0,`0)" />
20272050
</Docs>
20282051
</Member>
20292052
<MemberGroup MemberName="Multiply">
@@ -2242,6 +2265,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
22422265
<summary>To be added.</summary>
22432266
<value>To be added.</value>
22442267
<remarks>To be added.</remarks>
2268+
<inheritdoc cref="P:System.Numerics.Vector4.NaN" />
22452269
</Docs>
22462270
</Member>
22472271
<Member MemberName="Negate">
@@ -2315,6 +2339,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
23152339
<summary>To be added.</summary>
23162340
<value>To be added.</value>
23172341
<remarks>To be added.</remarks>
2342+
<inheritdoc cref="P:System.Numerics.Vector4.NegativeInfinity" />
23182343
</Docs>
23192344
</Member>
23202345
<Member MemberName="NegativeZero">
@@ -2342,6 +2367,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
23422367
<summary>To be added.</summary>
23432368
<value>To be added.</value>
23442369
<remarks>To be added.</remarks>
2370+
<inheritdoc cref="P:System.Numerics.Vector4.NegativeZero" />
23452371
</Docs>
23462372
</Member>
23472373
<Member MemberName="Normalize">
@@ -2430,6 +2456,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
24302456
<summary>Gets a vector whose 2 elements are equal to one.</summary>
24312457
<value>A vector whose two elements are equal to one (that is, it returns the vector <c>(1,1)</c>).</value>
24322458
<remarks>To be added.</remarks>
2459+
<inheritdoc cref="P:System.Numerics.Vector4.One" />
24332460
</Docs>
24342461
</Member>
24352462
<Member MemberName="op_Addition">
@@ -3022,6 +3049,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
30223049
<summary>To be added.</summary>
30233050
<value>To be added.</value>
30243051
<remarks>To be added.</remarks>
3052+
<inheritdoc cref="P:System.Numerics.Vector4.Pi" />
30253053
</Docs>
30263054
</Member>
30273055
<Member MemberName="PositiveInfinity">
@@ -3049,6 +3077,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
30493077
<summary>To be added.</summary>
30503078
<value>To be added.</value>
30513079
<remarks>To be added.</remarks>
3080+
<inheritdoc cref="P:System.Numerics.Vector4.PositiveInfinity" />
30523081
</Docs>
30533082
</Member>
30543083
<Member MemberName="RadiansToDegrees">
@@ -3080,6 +3109,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
30803109
<summary>To be added.</summary>
30813110
<returns>To be added.</returns>
30823111
<remarks>To be added.</remarks>
3112+
<inheritdoc cref="M:System.Numerics.Vector4.RadiansToDegrees(System.Numerics.Vector4)" />
30833113
</Docs>
30843114
</Member>
30853115
<Member MemberName="Reflect">
@@ -3159,6 +3189,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
31593189
<summary>To be added.</summary>
31603190
<returns>To be added.</returns>
31613191
<remarks>To be added.</remarks>
3192+
<inheritdoc cref="M:System.Numerics.Vector4.Round(System.Numerics.Vector4)" />
31623193
</Docs>
31633194
</Member>
31643195
<Member MemberName="Round">
@@ -3192,6 +3223,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
31923223
<summary>To be added.</summary>
31933224
<returns>To be added.</returns>
31943225
<remarks>To be added.</remarks>
3226+
<inheritdoc cref="M:System.Numerics.Vector4.Round(System.Numerics.Vector4,System.MidpointRounding)" />
31953227
</Docs>
31963228
</Member>
31973229
<Member MemberName="Sin">
@@ -3223,6 +3255,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
32233255
<summary>To be added.</summary>
32243256
<returns>To be added.</returns>
32253257
<remarks>To be added.</remarks>
3258+
<inheritdoc cref="M:System.Numerics.Vector4.Sin(System.Numerics.Vector4)" />
32263259
</Docs>
32273260
</Member>
32283261
<Member MemberName="SinCos">
@@ -3260,6 +3293,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
32603293
<summary>To be added.</summary>
32613294
<returns>To be added.</returns>
32623295
<remarks>To be added.</remarks>
3296+
<inheritdoc cref="M:System.Numerics.Vector4.SinCos(System.Numerics.Vector4)" />
32633297
</Docs>
32643298
</Member>
32653299
<Member MemberName="SquareRoot">
@@ -3381,6 +3415,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
33813415
<summary>To be added.</summary>
33823416
<value>To be added.</value>
33833417
<remarks>To be added.</remarks>
3418+
<inheritdoc cref="P:System.Numerics.Vector4.Tau" />
33843419
</Docs>
33853420
</Member>
33863421
<MemberGroup MemberName="ToString">
@@ -3903,6 +3938,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
39033938
<summary>To be added.</summary>
39043939
<returns>To be added.</returns>
39053940
<remarks>To be added.</remarks>
3941+
<inheritdoc cref="M:System.Numerics.Vector4.Truncate(System.Numerics.Vector4)" />
39063942
</Docs>
39073943
</Member>
39083944
<Member MemberName="TryCopyTo">
@@ -4152,6 +4188,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
41524188
<summary>Returns a vector whose 2 elements are equal to zero.</summary>
41534189
<value>A vector whose two elements are equal to zero (that is, it returns the vector <c>(0,0)</c>).</value>
41544190
<remarks>To be added.</remarks>
4191+
<inheritdoc cref="P:System.Numerics.Vector4.Zero" />
41554192
</Docs>
41564193
</Member>
41574194
</Members>

0 commit comments

Comments
 (0)