Skip to content

Commit 25b7484

Browse files
dakersnargewarrencarlossanlop
authored
Fix api documentation for System/System.Numerics (#8423)
* Add documentation for *TryParse(TryParse(System.String,System.IFormatProvider,*) * Fix parameter documentation for Decimal.Sign * Fix documentation for Type.GetEnumValuesAsUnderlyingType and Enum.GetValuesAsUnderlyingType * Fix parameter documentation for UInt128/Int128.CompareTo * Fix documentation for UInt128/Int128.ToString * Fix documentation for UInt128/Int128.Parse * Fix documentation for UInt128/Int128.TryParse * Cleanup * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> * Update xml/System/Enum.xml Co-authored-by: Genevieve Warren <[email protected]> * Apply suggestions from code review for Type.xml * Apply suggestions from code review for Int128/UInt128 * Apply suggestions from code review for Int128/UInt128 * Fix error with Decimal.Sign param * Fix documentation for System types * Fix BigInteger.TryParse docs * Fix IBinaryInteger documentation * Fix NFloat.TryParse documentation * Fix *.Item documentation issues * Fix 'Tries to parses' typo * Update xml/System.Numerics/Matrix3x2.xml Co-authored-by: Genevieve Warren <[email protected]> * Update xml/System.Numerics/Matrix4x4.xml Co-authored-by: Genevieve Warren <[email protected]> * Update xml/System.Numerics/Matrix3x2.xml Co-authored-by: Carlos Sanchez <[email protected]> * Update xml/System.Numerics/Matrix4x4.xml Co-authored-by: Carlos Sanchez <[email protected]> Co-authored-by: Genevieve Warren <[email protected]> Co-authored-by: Carlos Sanchez <[email protected]>
1 parent 270c747 commit 25b7484

32 files changed

+106
-71
lines changed

‎xml/System.Numerics/BigInteger.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10105,6 +10105,7 @@ The integer value `33022` can be exported in four different arrays:
1010510105
<summary>To be added.</summary>
1010610106
<returns>To be added.</returns>
1010710107
<remarks>To be added.</remarks>
10108+
<inheritdoc cref="M:System.IParsable`1.TryParse(System.String,System.IFormatProvider,`0@)" />
1010810109
</Docs>
1010910110
</Member>
1011010111
<Member MemberName="TryParse">

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1285,7 +1285,7 @@ For <xref:System.Numerics.IFloatingPointIeee754%601> this method matches the IEE
12851285
<param name="style">A bitwise combination of number styles that can be present in <paramref name="s" />.</param>
12861286
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
12871287
<param name="result">On return, contains the result of succesfully parsing <paramref name="s" /> or an undefined value on failure.</param>
1288-
<summary>Tries to parses a span of characters into a value.</summary>
1288+
<summary>Tries to parse a span of characters into a value.</summary>
12891289
<returns>
12901290
<see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
12911291
<remarks>To be added.</remarks>
@@ -1326,7 +1326,7 @@ For <xref:System.Numerics.IFloatingPointIeee754%601> this method matches the IEE
13261326
<param name="style">A bitwise combination of number styles that can be present in <paramref name="s" />.</param>
13271327
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
13281328
<param name="result">On return, contains the result of succesfully parsing <paramref name="s" /> or an undefined value on failure.</param>
1329-
<summary>Tries to parses a string into a value.</summary>
1329+
<summary>Tries to parse a string into a value.</summary>
13301330
<returns>
13311331
<see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
13321332
<remarks>To be added.</remarks>

‎xml/System.Numerics/Matrix3x2.xml‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1125,11 +1125,15 @@
11251125
<Parameter Name="column" Type="System.Int32" Index="1" FrameworkAlternate="net-7.0" />
11261126
</Parameters>
11271127
<Docs>
1128-
<param name="row">To be added.</param>
1129-
<param name="column">To be added.</param>
1130-
<summary>To be added.</summary>
1131-
<value>To be added.</value>
1128+
<param name="row">The index of the row containing the element to get or set.</param>
1129+
<param name="column">The index of the column containing the element to get or set.</param>
1130+
<summary>Gets or sets the element at the specified indices.</summary>
1131+
<value>The element at [<paramref name="row" />][<paramref name="column" />].</value>
11321132
<remarks>To be added.</remarks>
1133+
<exception cref="T:System.ArgumentOutOfRangeException">
1134+
<para><paramref name="row" /> was less than zero or greater than the number of rows.</para>
1135+
<para>-or-</para>
1136+
<para><paramref name="column" /> was less than zero or greater than the number of columns.</para></exception>
11331137
</Docs>
11341138
</Member>
11351139
<Member MemberName="Lerp">

‎xml/System.Numerics/Matrix4x4.xml‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2058,11 +2058,15 @@
20582058
<Parameter Name="column" Type="System.Int32" Index="1" FrameworkAlternate="net-7.0" />
20592059
</Parameters>
20602060
<Docs>
2061-
<param name="row">To be added.</param>
2062-
<param name="column">To be added.</param>
2063-
<summary>To be added.</summary>
2064-
<value>To be added.</value>
2061+
<param name="row">The index of the row containing the element to get or set.</param>
2062+
<param name="column">The index of the column containing the element to get or set.</param>
2063+
<summary>Gets or sets the element at the specified indices.</summary>
2064+
<value>The element at [<paramref name="row" />][<paramref name="column" />].</value>
20652065
<remarks>To be added.</remarks>
2066+
<exception cref="T:System.ArgumentOutOfRangeException">
2067+
<para><paramref name="row" /> was less than zero or greater than the number of rows.</para>
2068+
<para>-or-</para>
2069+
<para><paramref name="column" /> was less than zero or greater than the number of columns.</para></exception>
20662070
</Docs>
20672071
</Member>
20682072
<Member MemberName="Lerp">

‎xml/System.Numerics/Quaternion.xml‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -859,10 +859,12 @@ w = cos(theta/2)
859859
<Parameter Name="index" Type="System.Int32" Index="0" FrameworkAlternate="net-7.0" />
860860
</Parameters>
861861
<Docs>
862-
<param name="index">To be added.</param>
863-
<summary>To be added.</summary>
864-
<value>To be added.</value>
862+
<param name="index">The index of the element to get or set.</param>
863+
<summary>Gets or sets the element at the specified index.</summary>
864+
<value>The element at <paramref name="index" />.</value>
865865
<remarks>To be added.</remarks>
866+
<exception cref="T:System.ArgumentOutOfRangeException">
867+
<paramref name="index" /> was less than zero or greater than the number of elements.</exception>
866868
</Docs>
867869
</Member>
868870
<Member MemberName="Length">

‎xml/System.Numerics/Vector2.xml‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -942,10 +942,12 @@
942942
<Parameter Name="index" Type="System.Int32" Index="0" FrameworkAlternate="net-7.0" />
943943
</Parameters>
944944
<Docs>
945-
<param name="index">To be added.</param>
946-
<summary>To be added.</summary>
947-
<value>To be added.</value>
945+
<param name="index">The index of the element to get or set.</param>
946+
<summary>Gets or sets the element at the specified index.</summary>
947+
<value>The the element at <paramref name="index" />.</value>
948948
<remarks>To be added.</remarks>
949+
<exception cref="T:System.ArgumentOutOfRangeException">
950+
<paramref name="index" /> was less than zero or greater than the number of elements.</exception>
949951
</Docs>
950952
</Member>
951953
<Member MemberName="Length">

‎xml/System.Numerics/Vector3.xml‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1030,10 +1030,12 @@
10301030
<Parameter Name="index" Type="System.Int32" Index="0" FrameworkAlternate="net-7.0" />
10311031
</Parameters>
10321032
<Docs>
1033-
<param name="index">To be added.</param>
1034-
<summary>To be added.</summary>
1035-
<value>To be added.</value>
1033+
<param name="index">The index of the element to get or set.</param>
1034+
<summary>Gets or sets the element at the specified index.</summary>
1035+
<value>The the element at <paramref name="index" />.</value>
10361036
<remarks>To be added.</remarks>
1037+
<exception cref="T:System.ArgumentOutOfRangeException">
1038+
<paramref name="index" /> was less than zero or greater than the number of elements.</exception>
10371039
</Docs>
10381040
</Member>
10391041
<Member MemberName="Length">

‎xml/System.Numerics/Vector4.xml‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1030,10 +1030,12 @@
10301030
<Parameter Name="index" Type="System.Int32" Index="0" FrameworkAlternate="net-7.0" />
10311031
</Parameters>
10321032
<Docs>
1033-
<param name="index">To be added.</param>
1034-
<summary>To be added.</summary>
1035-
<value>To be added.</value>
1033+
<param name="index">The index of the element to get or set.</param>
1034+
<summary>Gets or sets the element at the specified index.</summary>
1035+
<value>The the element at <paramref name="index" />.</value>
10361036
<remarks>To be added.</remarks>
1037+
<exception cref="T:System.ArgumentOutOfRangeException">
1038+
<paramref name="index" /> was less than zero or greater than the number of elements.</exception>
10371039
</Docs>
10381040
</Member>
10391041
<Member MemberName="Length">

‎xml/System.Runtime.InteropServices/NFloat.xml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5673,7 +5673,7 @@ This computes `tan(x * π)`.
56735673
<param name="s">To be added.</param>
56745674
<param name="provider">To be added.</param>
56755675
<param name="result">To be added.</param>
5676-
<summary>Tries to parses a span of characters into a value.</summary>
5676+
<summary>Tries to parse a span of characters into a value.</summary>
56775677
<returns>
56785678
<see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
56795679
<remarks>To be added.</remarks>
@@ -5714,6 +5714,7 @@ This computes `tan(x * π)`.
57145714
<summary>To be added.</summary>
57155715
<returns>To be added.</returns>
57165716
<remarks>To be added.</remarks>
5717+
<inheritdoc cref="M:System.IParsable`1.TryParse(System.String,System.IFormatProvider,`0@)" />
57175718
</Docs>
57185719
</Member>
57195720
<Member MemberName="TryParse">

‎xml/System/Byte.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3779,7 +3779,7 @@ This member is an explicit interface member implementation. It can be used only
37793779
<param name="s">To be added.</param>
37803780
<param name="provider">To be added.</param>
37813781
<param name="result">To be added.</param>
3782-
<summary>Tries to parses a span of characters into a value.</summary>
3782+
<summary>Tries to parse a span of characters into a value.</summary>
37833783
<returns>
37843784
<see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
37853785
<remarks>To be added.</remarks>
@@ -3823,7 +3823,7 @@ This member is an explicit interface member implementation. It can be used only
38233823
<param name="s">The string to parse.</param>
38243824
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
38253825
<param name="result">When this method returns, contains the result of successfully parsing <paramref name="s" /> or an undefined value on failure.</param>
3826-
<summary>Tries to parses a string into a value.</summary>
3826+
<summary>Tries to parse a string into a value.</summary>
38273827
<returns>
38283828
<see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
38293829
<remarks>To be added.</remarks>

0 commit comments

Comments
 (0)