Skip to content

Commit d529454

Browse files
ericstjericstj
committed
System.Numerics docs
1 parent cc987b7 commit d529454

File tree

9 files changed

+642
-324
lines changed

9 files changed

+642
-324
lines changed

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

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -166,12 +166,14 @@
166166
<Parameter Name="max" Type="TSelf" Index="2" FrameworkAlternate="net-10.0" />
167167
</Parameters>
168168
<Docs>
169-
<param name="value">To be added.</param>
170-
<param name="min">To be added.</param>
171-
<param name="max">To be added.</param>
172-
<summary>To be added.</summary>
173-
<returns>To be added.</returns>
169+
<param name="value">The value to clamp.</param>
170+
<param name="min">The inclusive minimum to which <paramref name="value" /> should clamp.</param>
171+
<param name="max">The inclusive maximum to which <paramref name="value" /> should clamp.</param>
172+
<summary>Clamps a value to an inclusive minimum and maximum value using platform-specific behavior for <c>NaN</c> and <c>NegativeZero</c>.</summary>
173+
<returns>The result of clamping <paramref name="value" /> to the inclusive range of <paramref name="min" /> and <paramref name="max" />.</returns>
174174
<remarks>To be added.</remarks>
175+
<exception cref="T:System.ArgumentException">
176+
<paramref name="min" /> is greater than <paramref name="max" />.</exception>
175177
</Docs>
176178
</Member>
177179
<Member MemberName="CopySign">
@@ -263,10 +265,11 @@ For <xref:System.Numerics.IFloatingPoint%601>, this method matches the IEEE 754:
263265
<Parameter Name="y" Type="TSelf" Index="1" FrameworkAlternate="net-10.0" />
264266
</Parameters>
265267
<Docs>
266-
<param name="x">To be added.</param>
267-
<param name="y">To be added.</param>
268-
<summary>To be added.</summary>
269-
<returns>To be added.</returns>
268+
<param name="x">The value to compare with <paramref name="y" />.</param>
269+
<param name="y">The value to compare with <paramref name="x" />.</param>
270+
<summary>Compares two values to compute which is greater using platform-specific behavior for <c>NaN</c> and <c>NegativeZero</c>.</summary>
271+
<returns>
272+
<paramref name="x" /> if it is greater than <paramref name="y" />; otherwise, <paramref name="y" />.</returns>
270273
<remarks>To be added.</remarks>
271274
</Docs>
272275
</Member>
@@ -368,10 +371,11 @@ For <xref:System.Numerics.IFloatingPoint%601>, this method matches the IEEE 754:
368371
<Parameter Name="y" Type="TSelf" Index="1" FrameworkAlternate="net-10.0" />
369372
</Parameters>
370373
<Docs>
371-
<param name="x">To be added.</param>
372-
<param name="y">To be added.</param>
373-
<summary>To be added.</summary>
374-
<returns>To be added.</returns>
374+
<param name="x">The value to compare with <paramref name="y" />.</param>
375+
<param name="y">The value to compare with <paramref name="x" />.</param>
376+
<summary>Compares two values to compute which is lesser using platform-specific behavior for <c>NaN</c> and <c>NegativeZero</c>.</summary>
377+
<returns>
378+
<paramref name="x" /> if it is lesser than <paramref name="y" />; otherwise, <paramref name="y" />.</returns>
375379
<remarks>To be added.</remarks>
376380
</Docs>
377381
</Member>

‎xml/System.Numerics/Matrix3x2.xml‎

Lines changed: 71 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -189,9 +189,9 @@
189189
<Parameter Name="value" Type="System.Numerics.Vector2" Index="0" FrameworkAlternate="net-10.0" />
190190
</Parameters>
191191
<Docs>
192-
<param name="value">To be added.</param>
193-
<summary>To be added.</summary>
194-
<returns>To be added.</returns>
192+
<param name="value">The value to assign to all 3 rows.</param>
193+
<summary>Creates a <see cref="T:System.Numerics.Matrix3x2" /> whose 3 rows are set to the specified value.</summary>
194+
<returns>A <see cref="T:System.Numerics.Matrix3x2" /> whose 3 rows are set to <paramref name="value" />.</returns>
195195
<remarks>To be added.</remarks>
196196
</Docs>
197197
</Member>
@@ -220,9 +220,9 @@
220220
<Parameter Name="value" Type="System.Single" Index="0" FrameworkAlternate="net-10.0" />
221221
</Parameters>
222222
<Docs>
223-
<param name="value">To be added.</param>
224-
<summary>To be added.</summary>
225-
<returns>To be added.</returns>
223+
<param name="value">The value to assign to all 6 elements.</param>
224+
<summary>Creates a <see cref="T:System.Numerics.Matrix3x2" /> whose 6 elements are set to the specified value.</summary>
225+
<returns>A <see cref="T:System.Numerics.Matrix3x2" /> whose 6 elements are set to <paramref name="value" />.</returns>
226226
<remarks>To be added.</remarks>
227227
</Docs>
228228
</Member>
@@ -253,11 +253,11 @@
253253
<Parameter Name="z" Type="System.Numerics.Vector2" Index="2" FrameworkAlternate="net-10.0" />
254254
</Parameters>
255255
<Docs>
256-
<param name="x">To be added.</param>
257-
<param name="y">To be added.</param>
258-
<param name="z">To be added.</param>
259-
<summary>To be added.</summary>
260-
<returns>To be added.</returns>
256+
<param name="x">The value to assign to <see cref="P:System.Numerics.Matrix3x2.X" />.</param>
257+
<param name="y">The value to assign to <see cref="P:System.Numerics.Matrix3x2.Y" />.</param>
258+
<param name="z">The value to assign to <see cref="P:System.Numerics.Matrix3x2.Z" />.</param>
259+
<summary>Creates a <see cref="T:System.Numerics.Matrix3x2" /> from the specified rows.</summary>
260+
<returns>A <see cref="T:System.Numerics.Matrix3x2" /> whose rows are set to the specified values.</returns>
261261
<remarks>To be added.</remarks>
262262
</Docs>
263263
</Member>
@@ -291,14 +291,14 @@
291291
<Parameter Name="m32" Type="System.Single" Index="5" FrameworkAlternate="net-10.0" />
292292
</Parameters>
293293
<Docs>
294-
<param name="m11">To be added.</param>
295-
<param name="m12">To be added.</param>
296-
<param name="m21">To be added.</param>
297-
<param name="m22">To be added.</param>
298-
<param name="m31">To be added.</param>
299-
<param name="m32">To be added.</param>
300-
<summary>To be added.</summary>
301-
<returns>To be added.</returns>
294+
<param name="m11">The value to assign to <see cref="F:System.Numerics.Matrix3x2.M11" />.</param>
295+
<param name="m12">The value to assign to <see cref="F:System.Numerics.Matrix3x2.M12" />.</param>
296+
<param name="m21">The value to assign to <see cref="F:System.Numerics.Matrix3x2.M21" />.</param>
297+
<param name="m22">The value to assign to <see cref="F:System.Numerics.Matrix3x2.M22" />.</param>
298+
<param name="m31">The value to assign to <see cref="F:System.Numerics.Matrix3x2.M31" />.</param>
299+
<param name="m32">The value to assign to <see cref="F:System.Numerics.Matrix3x2.M32" />.</param>
300+
<summary>Creates a <see cref="T:System.Numerics.Matrix3x2" /> from the specified elements.</summary>
301+
<returns>A <see cref="T:System.Numerics.Matrix3x2" /> whose elements are set to the specified values.</returns>
302302
<remarks>To be added.</remarks>
303303
</Docs>
304304
</Member>
@@ -1166,11 +1166,18 @@
11661166
<Parameter Name="column" Type="System.Int32" Index="1" FrameworkAlternate="net-10.0" />
11671167
</Parameters>
11681168
<Docs>
1169-
<param name="row">To be added.</param>
1170-
<param name="column">To be added.</param>
1171-
<summary>To be added.</summary>
1172-
<returns>To be added.</returns>
1169+
<param name="row">The index of the row containing the element to get.</param>
1170+
<param name="column">The index of the column containing the element to get.</param>
1171+
<summary>Gets the element at the specified row and column.</summary>
1172+
<returns>The element at index: [<paramref name="row" />, <paramref name="column" />].</returns>
11731173
<remarks>To be added.</remarks>
1174+
<exception cref="T:System.ArgumentOutOfRangeException">
1175+
<para>
1176+
<paramref name="row" /> was less than zero or greater than or equal to the number of rows (<c>3</c>).</para>
1177+
<para>-or-</para>
1178+
<para>
1179+
<paramref name="column" /> was less than zero or greater than or equal to the number of columns (<c>2</c>).</para>
1180+
</exception>
11741181
</Docs>
11751182
</Member>
11761183
<Member MemberName="GetHashCode">
@@ -1255,10 +1262,12 @@
12551262
<Parameter Name="index" Type="System.Int32" Index="0" FrameworkAlternate="net-10.0" />
12561263
</Parameters>
12571264
<Docs>
1258-
<param name="index">To be added.</param>
1259-
<summary>To be added.</summary>
1260-
<returns>To be added.</returns>
1265+
<param name="index">The index of the row to get.</param>
1266+
<summary>Gets or sets the row at the specified index.</summary>
1267+
<returns>The row at index: [<paramref name="index" />].</returns>
12611268
<remarks>To be added.</remarks>
1269+
<exception cref="T:System.ArgumentOutOfRangeException">
1270+
<paramref name="index" /> was less than zero or greater than or equal to the number of rows (<c>3</c>).</exception>
12621271
</Docs>
12631272
</Member>
12641273
<Member MemberName="Identity">
@@ -1435,10 +1444,12 @@
14351444
<Parameter Name="row" Type="System.Int32" Index="0" FrameworkAlternate="net-10.0" />
14361445
</Parameters>
14371446
<Docs>
1438-
<param name="row">To be added.</param>
1439-
<summary>To be added.</summary>
1440-
<value>To be added.</value>
1447+
<param name="row">The index of the row to get or set.</param>
1448+
<summary>Gets or sets the row at the specified index.</summary>
1449+
<value>The row at index: [<paramref name="row" />].</value>
14411450
<remarks>To be added.</remarks>
1451+
<exception cref="T:System.ArgumentOutOfRangeException">
1452+
<paramref name="row" /> was less than zero or greater than or equal to the number of rows (<c>3</c>).</exception>
14421453
</Docs>
14431454
</Member>
14441455
<Member MemberName="Item">
@@ -1580,7 +1591,7 @@
15801591
</ReturnValue>
15811592
<Docs>
15821593
<summary>The first element of the first row.</summary>
1583-
<remarks>To be added.</remarks>
1594+
<remarks>This element exists at index: <c>[0, 0]</c> and is part of row <see cref="P:System.Numerics.Matrix3x2.X" />.</remarks>
15841595
</Docs>
15851596
</Member>
15861597
<Member MemberName="M12">
@@ -1622,7 +1633,7 @@
16221633
</ReturnValue>
16231634
<Docs>
16241635
<summary>The second element of the first row.</summary>
1625-
<remarks>To be added.</remarks>
1636+
<remarks>This element exists at index: <c>[0, 1]</c> and is part of row <see cref="P:System.Numerics.Matrix3x2.X" />.</remarks>
16261637
</Docs>
16271638
</Member>
16281639
<Member MemberName="M21">
@@ -1664,7 +1675,7 @@
16641675
</ReturnValue>
16651676
<Docs>
16661677
<summary>The first element of the second row.</summary>
1667-
<remarks>To be added.</remarks>
1678+
<remarks>This element exists at index: <c>[1, 0]</c> and is part of row <see cref="P:System.Numerics.Matrix3x2.Y" />.</remarks>
16681679
</Docs>
16691680
</Member>
16701681
<Member MemberName="M22">
@@ -1706,7 +1717,7 @@
17061717
</ReturnValue>
17071718
<Docs>
17081719
<summary>The second element of the second row.</summary>
1709-
<remarks>To be added.</remarks>
1720+
<remarks>This element exists at index: <c>[1, 1]</c> and is part of row <see cref="P:System.Numerics.Matrix3x2.Y" />.</remarks>
17101721
</Docs>
17111722
</Member>
17121723
<Member MemberName="M31">
@@ -1748,7 +1759,7 @@
17481759
</ReturnValue>
17491760
<Docs>
17501761
<summary>The first element of the third row.</summary>
1751-
<remarks>To be added.</remarks>
1762+
<remarks>This element exists at index: <c>[2, 0]</c> and is part of row <see cref="P:System.Numerics.Matrix3x2.Z" />.</remarks>
17521763
</Docs>
17531764
</Member>
17541765
<Member MemberName="M32">
@@ -1790,7 +1801,7 @@
17901801
</ReturnValue>
17911802
<Docs>
17921803
<summary>The second element of the third row.</summary>
1793-
<remarks>To be added.</remarks>
1804+
<remarks>This element exists at index: <c>[2, 1]</c> and is part of row <see cref="P:System.Numerics.Matrix3x2.Z" />.</remarks>
17941805
</Docs>
17951806
</Member>
17961807
<MemberGroup MemberName="Multiply">
@@ -2492,7 +2503,7 @@
24922503
<Docs>
24932504
<summary>Gets or sets the translation component of this matrix.</summary>
24942505
<value>The translation component of the current instance.</value>
2495-
<remarks>To be added.</remarks>
2506+
<remarks>The translation component is stored as <see cref="P:System.Numerics.Matrix3x2.Z" />.</remarks>
24962507
</Docs>
24972508
</Member>
24982509
<Member MemberName="WithElement">
@@ -2528,12 +2539,19 @@
25282539
<Parameter Name="value" Type="System.Single" Index="2" FrameworkAlternate="net-10.0" />
25292540
</Parameters>
25302541
<Docs>
2531-
<param name="row">To be added.</param>
2532-
<param name="column">To be added.</param>
2533-
<param name="value">To be added.</param>
2534-
<summary>To be added.</summary>
2535-
<returns>To be added.</returns>
2542+
<param name="row">The index of the row containing the element to replace.</param>
2543+
<param name="column">The index of the column containing the element to replace.</param>
2544+
<param name="value">The value to assign to the element at index: [<paramref name="row" />, <paramref name="column" />].</param>
2545+
<summary>Creates a new <see cref="T:System.Numerics.Matrix3x2" /> with the element at the specified row and column set to the given value and the remaining elements set to the same value as that in the current matrix.</summary>
2546+
<returns>A <see cref="T:System.Numerics.Matrix3x2" /> with the value of the element at index: [<paramref name="row" />, <paramref name="column" />] set to <paramref name="value" /> and the remaining elements set to the same value as that in the current matrix.</returns>
25362547
<remarks>To be added.</remarks>
2548+
<exception cref="T:System.ArgumentOutOfRangeException">
2549+
<para>
2550+
<paramref name="row" /> was less than zero or greater than or equal to the number of rows (<c>3</c>).</para>
2551+
<para>-or-</para>
2552+
<para>
2553+
<paramref name="column" /> was less than zero or greater than or equal to the number of columns (<c>2</c>).</para>
2554+
</exception>
25372555
</Docs>
25382556
</Member>
25392557
<Member MemberName="WithRow">
@@ -2568,11 +2586,13 @@
25682586
<Parameter Name="value" Type="System.Numerics.Vector2" Index="1" FrameworkAlternate="net-10.0" />
25692587
</Parameters>
25702588
<Docs>
2571-
<param name="index">To be added.</param>
2572-
<param name="value">To be added.</param>
2573-
<summary>To be added.</summary>
2574-
<returns>To be added.</returns>
2589+
<param name="index">The index of the row to replace.</param>
2590+
<param name="value">The value to assign to the row at index: [<paramref name="index" />].</param>
2591+
<summary>Creates a new <see cref="T:System.Numerics.Matrix3x2" /> with the row at the specified index set to the given value and the remaining rows set to the same value as that in the current matrix.</summary>
2592+
<returns>A <see cref="T:System.Numerics.Matrix3x2" /> with the value of the row at index: [<paramref name="index" />] set to <paramref name="value" /> and the remaining rows set to the same value as that in the current matrix.</returns>
25752593
<remarks>To be added.</remarks>
2594+
<exception cref="T:System.ArgumentOutOfRangeException">
2595+
<paramref name="index" /> was less than zero or greater than or equal to the number of rows (<c>3</c>).</exception>
25762596
</Docs>
25772597
</Member>
25782598
<Member MemberName="X">
@@ -2603,9 +2623,9 @@
26032623
<ReturnType>System.Numerics.Vector2</ReturnType>
26042624
</ReturnValue>
26052625
<Docs>
2606-
<summary>To be added.</summary>
2626+
<summary>Gets or sets the first row of the matrix.</summary>
26072627
<value>To be added.</value>
2608-
<remarks>To be added.</remarks>
2628+
<remarks>This row comprises <see cref="F:System.Numerics.Matrix3x2.M11" /> and <see cref="F:System.Numerics.Matrix3x2.M12" />; it exists at index: <c>[0]</c>.</remarks>
26092629
</Docs>
26102630
</Member>
26112631
<Member MemberName="Y">
@@ -2636,9 +2656,9 @@
26362656
<ReturnType>System.Numerics.Vector2</ReturnType>
26372657
</ReturnValue>
26382658
<Docs>
2639-
<summary>To be added.</summary>
2659+
<summary>Gets or sets the second row of the matrix.</summary>
26402660
<value>To be added.</value>
2641-
<remarks>To be added.</remarks>
2661+
<remarks>This row comprises <see cref="F:System.Numerics.Matrix3x2.M21" /> and <see cref="F:System.Numerics.Matrix3x2.M22" />; it exists at index: <c>[1]</c>.</remarks>
26422662
</Docs>
26432663
</Member>
26442664
<Member MemberName="Z">
@@ -2669,9 +2689,9 @@
26692689
<ReturnType>System.Numerics.Vector2</ReturnType>
26702690
</ReturnValue>
26712691
<Docs>
2672-
<summary>To be added.</summary>
2692+
<summary>Gets or sets the third row of the matrix.</summary>
26732693
<value>To be added.</value>
2674-
<remarks>To be added.</remarks>
2694+
<remarks>This row comprises <see cref="F:System.Numerics.Matrix3x2.M31" /> and <see cref="F:System.Numerics.Matrix3x2.M32" />; it exists at index: <c>[2]</c>.</remarks>
26752695
</Docs>
26762696
</Member>
26772697
</Members>

0 commit comments

Comments
 (0)