Skip to content

Commit 8dfd6d3

Browse files
dakersnardakersnar
authored
Update System.Numerics Docs (#8403)
1 parent fae4e8d commit 8dfd6d3

18 files changed

Lines changed: 226 additions & 193 deletions

‎xml/System/Byte.xml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3820,9 +3820,9 @@ This member is an explicit interface member implementation. It can be used only
38203820
<Parameter Name="result" Type="System.Byte" RefType="out" Index="2" FrameworkAlternate="net-7.0" />
38213821
</Parameters>
38223822
<Docs>
3823-
<param name="s">To be added.</param>
3824-
<param name="provider">To be added.</param>
3825-
<param name="result">To be added.</param>
3823+
<param name="s">The string to parse.</param>
3824+
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
3825+
<param name="result">When this method returns, contains the result of successfully parsing <paramref name="s" /> or an undefined value on failure.</param>
38263826
<summary>Tries to parses a string into a value.</summary>
38273827
<returns>
38283828
<see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>

‎xml/System/Decimal.xml‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6599,7 +6599,7 @@ If you specify <xref:System.MidpointRounding.ToEven> or <xref:System.MidpointRou
65996599
<Parameter Name="d" Type="System.Decimal" Index="0" FrameworkAlternate="net-7.0" />
66006600
</Parameters>
66016601
<Docs>
6602-
<param name="d">To be added.</param>
6602+
<param name="value">The value whose sign is to be computed.</param>
66036603
<summary>Computes the sign of a value.</summary>
66046604
<returns>A positive value if <paramref name="value" /> is positive, <see cref="P:System.Numerics.INumberBase`1.Zero" /> if <paramref name="value" /> is zero, and a negative value if <paramref name="value" /> is negative.</returns>
66056605
<remarks>
@@ -9577,11 +9577,12 @@ This member is an explicit interface member implementation. It can be used only
95779577
<Parameter Name="result" Type="System.Decimal" RefType="out" Index="2" FrameworkAlternate="net-7.0" />
95789578
</Parameters>
95799579
<Docs>
9580-
<param name="s">To be added.</param>
9581-
<param name="provider">To be added.</param>
9582-
<param name="result">To be added.</param>
9583-
<summary>To be added.</summary>
9584-
<returns>To be added.</returns>
9580+
<param name="s">The string to parse.</param>
9581+
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
9582+
<param name="result">When this method returns, contains the result of successfully parsing <paramref name="s" /> or an undefined value on failure.</param>
9583+
<summary>Tries to parses a string into a value.</summary>
9584+
<returns>
9585+
<see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
95859586
<remarks>To be added.</remarks>
95869587
</Docs>
95879588
</Member>

‎xml/System/Double.xml‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7986,11 +7986,12 @@ If a separator is encountered in the `s` parameter during a parse operation, and
79867986
<Parameter Name="result" Type="System.Double" RefType="out" Index="2" FrameworkAlternate="net-7.0" />
79877987
</Parameters>
79887988
<Docs>
7989-
<param name="s">To be added.</param>
7990-
<param name="provider">To be added.</param>
7991-
<param name="result">To be added.</param>
7992-
<summary>To be added.</summary>
7993-
<returns>To be added.</returns>
7989+
<param name="s">The string to parse.</param>
7990+
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
7991+
<param name="result">When this method returns, contains the result of successfully parsing <paramref name="s" /> or an undefined value on failure.</param>
7992+
<summary>Tries to parses a string into a value.</summary>
7993+
<returns>
7994+
<see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
79947995
<remarks>To be added.</remarks>
79957996
</Docs>
79967997
</Member>

‎xml/System/Enum.xml‎

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1176,10 +1176,17 @@
11761176
<Parameter Name="enumType" Type="System.Type" Index="0" FrameworkAlternate="net-7.0" />
11771177
</Parameters>
11781178
<Docs>
1179-
<param name="enumType">To be added.</param>
1180-
<summary>To be added.</summary>
1181-
<returns>To be added.</returns>
1182-
<remarks>To be added.</remarks>
1179+
<param name="enumType">An enumeration type.</param>
1180+
<summary>Retrieves an array of the values of the underlying type constants in a specified enumeration.</summary>
1181+
<returns>An array that contains the values of the underlying type constants in <paramref name="enumType" />.</returns>
1182+
<remarks>
1183+
You can use this method to get enumeration values when it's hard to create an array of the enumeration type.
1184+
For example, you might use this method for the <see cref="T:System.Reflection.MetadataLoadContext" /> enumeration or on a platform where run-time code generation is not available.
1185+
</remarks>
1186+
<exception cref="T:System.ArgumentNullException">
1187+
<paramref name="enumType" /> is null.</exception>
1188+
<exception cref="T:System.ArgumentException">
1189+
<paramref name="enumType" /> is not an enumeration type.</exception>
11831190
</Docs>
11841191
</Member>
11851192
<Member MemberName="GetValuesAsUnderlyingType&lt;TEnum&gt;">
@@ -1215,10 +1222,13 @@
12151222
</TypeParameters>
12161223
<Parameters />
12171224
<Docs>
1218-
<typeparam name="TEnum">To be added.</typeparam>
1219-
<summary>To be added.</summary>
1220-
<returns>To be added.</returns>
1221-
<remarks>To be added.</remarks>
1225+
<typeparam name="TEnum">An enumeration type.</typeparam>
1226+
<summary>Retrieves an array of the values of the underlying type constants in a specified enumeration type.</summary>
1227+
<returns>An array that contains the values of the underlying type constants in <typeparamref name="TEnum" />.</returns>
1228+
<remarks>
1229+
You can use this method to get enumeration values when it's hard to create an array of the enumeration type.
1230+
For example, you might use this method for the <see cref="T:System.Reflection.MetadataLoadContext" /> enumeration or on a platform where run-time code generation is not available.
1231+
</remarks>
12221232
</Docs>
12231233
</Member>
12241234
<Member MemberName="HasFlag">

‎xml/System/Half.xml‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5665,7 +5665,7 @@ This computes `tan(x * π)`.
56655665
<param name="s">To be added.</param>
56665666
<param name="provider">To be added.</param>
56675667
<param name="result">To be added.</param>
5668-
<summary>Tries to parses a span of characters into a value.</summary>
5668+
<summary>Tries to parse a span of characters into a value.</summary>
56695669
<returns>
56705670
<see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
56715671
<remarks>To be added.</remarks>
@@ -5700,11 +5700,12 @@ This computes `tan(x * π)`.
57005700
<Parameter Name="result" Type="System.Half" RefType="out" Index="2" FrameworkAlternate="net-7.0" />
57015701
</Parameters>
57025702
<Docs>
5703-
<param name="s">To be added.</param>
5704-
<param name="provider">To be added.</param>
5705-
<param name="result">To be added.</param>
5706-
<summary>To be added.</summary>
5707-
<returns>To be added.</returns>
5703+
<param name="s">The string to parse.</param>
5704+
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
5705+
<param name="result">When this method returns, contains the result of successfully parsing <paramref name="s" /> or an undefined value on failure.</param>
5706+
<summary>Tries to parse a string into a value.</summary>
5707+
<returns>
5708+
<see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
57085709
<remarks>To be added.</remarks>
57095710
</Docs>
57105711
</Member>

0 commit comments

Comments
 (0)