Skip to content

Update System.Numerics Docs #8403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gewarren merged 15 commits into from
Sep 20, 2022
Merged

Update System.Numerics Docs #8403

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
6860461
Add documentation for *TryParse(TryParse(System.String,System.IFormat…
dakersnar Sep 19, 2022
3585a84
Fix parameter documentation for Decimal.Sign
dakersnar Sep 19, 2022
d906a80
Fix documentation for Type.GetEnumValuesAsUnderlyingType and Enum.Get…
dakersnar Sep 19, 2022
22760a7
Fix parameter documentation for UInt128/Int128.CompareTo
dakersnar Sep 19, 2022
363791e
Fix documentation for UInt128/Int128.ToString
dakersnar Sep 19, 2022
b34cd79
Fix documentation for UInt128/Int128.Parse
dakersnar Sep 19, 2022
b36b282
Fix documentation for UInt128/Int128.TryParse
dakersnar Sep 19, 2022
1acafcf
Cleanup
dakersnar Sep 19, 2022
3af9e3f
Apply suggestions from code review
dakersnar Sep 20, 2022
ce60f25
Apply suggestions from code review
dakersnar Sep 20, 2022
faac3ac
Apply suggestions from code review
dakersnar Sep 20, 2022
32a0ad3
Update xml/System/Enum.xml
dakersnar Sep 20, 2022
fc1ca15
Apply suggestions from code review for Type.xml
dakersnar Sep 20, 2022
f70f6e0
Apply suggestions from code review for Int128/UInt128
dakersnar Sep 20, 2022
f73a26d
Apply suggestions from code review for Int128/UInt128
dakersnar Sep 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions xml/System/Byte.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3820,9 +3820,9 @@ This member is an explicit interface member implementation. It can be used only
<Parameter Name="result" Type="System.Byte" RefType="out" Index="2" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="provider">To be added.</param>
<param name="result">To be added.</param>
<param name="s">The string to parse.</param>
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
<param name="result">When this method returns, contains the result of successfully parsing <paramref name="s" /> or an undefined value on failure.</param>
<summary>Tries to parses a string into a value.</summary>
<returns>
<see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
Expand Down
13 changes: 7 additions & 6 deletions xml/System/Decimal.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6599,7 +6599,7 @@ If you specify <xref:System.MidpointRounding.ToEven> or <xref:System.MidpointRou
<Parameter Name="d" Type="System.Decimal" Index="0" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="d">To be added.</param>
<param name="value">The value whose sign is to be computed.</param>
<summary>Computes the sign of a value.</summary>
<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>
<remarks>
Expand Down Expand Up @@ -9577,11 +9577,12 @@ This member is an explicit interface member implementation. It can be used only
<Parameter Name="result" Type="System.Decimal" RefType="out" Index="2" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="provider">To be added.</param>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">The string to parse.</param>
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
<param name="result">When this method returns, contains the result of successfully parsing <paramref name="s" /> or an undefined value on failure.</param>
<summary>Tries to parses a string into a value.</summary>
<returns>
<see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
11 changes: 6 additions & 5 deletions xml/System/Double.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7986,11 +7986,12 @@ If a separator is encountered in the `s` parameter during a parse operation, and
<Parameter Name="result" Type="System.Double" RefType="out" Index="2" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="provider">To be added.</param>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">The string to parse.</param>
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
<param name="result">When this method returns, contains the result of successfully parsing <paramref name="s" /> or an undefined value on failure.</param>
<summary>Tries to parses a string into a value.</summary>
<returns>
<see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
24 changes: 16 additions & 8 deletions xml/System/Enum.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1176,10 +1176,15 @@
<Parameter Name="enumType" Type="System.Type" Index="0" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="enumType">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="enumType">An enumeration type.</param>
<summary>Retrieves an array of the values of the underlying type constants in a specified enumeration.</summary>
<returns>An array that contains the values of the underlying type constants in <paramref name="enumType" />.</returns>
<remarks>
This method can be used to get enumeration values when creating an array of the enumeration type is challenging.
For example, <see cref="T:System.Reflection.MetadataLoadContext" /> or on a platform where runtime codegen is not available.
</remarks>
<exception cref="ArgumentNullException">Thrown when the enumeration type is null.</exception>
<exception cref="ArgumentException">Thrown when the type is not an enumeration type.</exception>
</Docs>
</Member>
<Member MemberName="GetValuesAsUnderlyingType&lt;TEnum&gt;">
Expand Down Expand Up @@ -1215,10 +1220,13 @@
</TypeParameters>
<Parameters />
<Docs>
<typeparam name="TEnum">To be added.</typeparam>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<typeparam name="TEnum">An enumeration type.</typeparam>
<summary>Retrieves an array of the values of the underlying type constants in a specified enumeration type.</summary>
<returns>An array that contains the values of the underlying type constants in enumType.</returns>
<remarks>
This method can be used to get enumeration values when creating an array of the enumeration type is challenging.
For example, <see cref="T:System.Reflection.MetadataLoadContext" /> or on a platform where runtime codegen is not available.
</remarks>
</Docs>
</Member>
<Member MemberName="HasFlag">
Expand Down
13 changes: 7 additions & 6 deletions xml/System/Half.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5665,7 +5665,7 @@ This computes `tan(x * π)`.
<param name="s">To be added.</param>
<param name="provider">To be added.</param>
<param name="result">To be added.</param>
<summary>Tries to parses a span of characters into a value.</summary>
<summary>Tries to parse a span of characters into a value.</summary>
<returns>
<see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
Expand Down Expand Up @@ -5700,11 +5700,12 @@ This computes `tan(x * π)`.
<Parameter Name="result" Type="System.Half" RefType="out" Index="2" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="provider">To be added.</param>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">The string to parse.</param>
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
<param name="result">When this method returns, contains the result of successfully parsing <paramref name="s" /> or an undefined value on failure.</param>
<summary>Tries to parse a string into a value.</summary>
<returns>
<see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
101 changes: 54 additions & 47 deletions xml/System/Int128.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@
<Parameter Name="value" Type="System.Int128" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<param name="other">An object to compare with this instance.</param>
<summary>Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.</summary>
<returns>
<para>A value that indicates the relative order of the objects being compared. The return value has these meanings:</para>
Expand Down Expand Up @@ -340,7 +340,7 @@
<Parameter Name="value" Type="System.Object" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<param name="obj">An object to compare with this instance.</param>
<summary>Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.</summary>
<returns>
<para>A value that indicates the relative order of the objects being compared. The return value has these meanings:</para>
Expand Down Expand Up @@ -2982,9 +2982,9 @@ This operation is meant to perform n unsigned (otherwise known as a logical) rig
<Parameter Name="s" Type="System.String" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">A string containing a number to parse.</param>
<summary>Parses a string into a value.</summary>
<returns>The result of parsing <paramref name="s" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -3011,8 +3011,8 @@ This operation is meant to perform n unsigned (otherwise known as a logical) rig
<Parameter Name="provider" Type="System.IFormatProvider" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="provider">To be added.</param>
<param name="s">The span of characters to parse.</param>
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
<summary>Parses a span of characters into a value.</summary>
<returns>The result of parsing <paramref name="s" />.</returns>
<remarks>To be added.</remarks>
Expand All @@ -3039,10 +3039,10 @@ This operation is meant to perform n unsigned (otherwise known as a logical) rig
<Parameter Name="style" Type="System.Globalization.NumberStyles" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="style">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">A string containing a number to parse.</param>
<param name="style">A bitwise combination of number styles that can be present in <paramref name="s" />.</param>
<summary>Parses a string into a value.</summary>
<returns>The result of parsing <paramref name="s" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -3425,9 +3425,9 @@ It is recommended that a function return `1`, `0`, and `-1`, respectively.
<Parameter Name="provider" Type="System.IFormatProvider" />
</Parameters>
<Docs>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="provider">An object that supplies culture-specific formatting information.</param>
<summary>Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information.</summary>
<returns>The string representation of the value of this instance as specified by <paramref name="provider" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -3457,9 +3457,11 @@ It is recommended that a function return `1`, `0`, and `-1`, respectively.
</Parameter>
</Parameters>
<Docs>
<param name="format">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="format">The format to use.
-or-
A <see langword="null" /> reference (<see langword="Nothing" /> in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable" /> implementation.</param>
<summary>Converts the numeric value of this instance to its equivalent string representation, using the specified format.</summary>
<returns>The string representation of the value of this instance as specified by <paramref name="format" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -3496,7 +3498,7 @@ It is recommended that a function return `1`, `0`, and `-1`, respectively.
<param name="format">The format to use.
-or-
A <see langword="null" /> reference (<see langword="Nothing" /> in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable" /> implementation.</param>
<param name="provider">To be added.</param>
<param name="provider">An object that supplies culture-specific formatting information.</param>
<summary>Formats the value of the current instance using the specified format.</summary>
<returns>The value of the current instance in the specified format.</returns>
<remarks>To be added.</remarks>
Expand Down Expand Up @@ -3592,10 +3594,11 @@ It is recommended that a function return `1`, `0`, and `-1`, respectively.
<Parameter Name="result" Type="System.Int128" RefType="out" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">The span of characters to parse.</param>
<param name="result">On return, contains the result of successfully parsing <paramref name="s" /> or an undefined value on failure.</param>
<summary>Tries to parse a span of characters into a value.</summary>
<returns>
<see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -3626,10 +3629,11 @@ It is recommended that a function return `1`, `0`, and `-1`, respectively.
<Parameter Name="result" Type="System.Int128" RefType="out" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">The string to parse.</param>
<param name="result">On return, contains the result of successfully parsing <paramref name="s" /> or an undefined value on failure.</param>
<summary>Tries to parse a string into a value.</summary>
<returns>
<see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -3654,10 +3658,10 @@ It is recommended that a function return `1`, `0`, and `-1`, respectively.
<Parameter Name="result" Type="System.Int128" RefType="out" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="provider">To be added.</param>
<param name="result">To be added.</param>
<summary>Tries to parses a span of characters into a value.</summary>
<param name="s">The string to parse.</param>
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
<param name="result">On return, contains the result of successfully parsing <paramref name="s" /> or an undefined value on failure.</param>
<summary>Tries to parse a string into a value.</summary>
<returns>
<see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
Expand Down Expand Up @@ -3692,11 +3696,12 @@ It is recommended that a function return `1`, `0`, and `-1`, respectively.
<Parameter Name="result" Type="System.Int128" RefType="out" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="provider">To be added.</param>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">The string to parse.</param>
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
<param name="result">On return, contains the result of successfully parsing <paramref name="s" /> or an undefined value on failure.</param>
<summary>Tries to parse a string into a value.</summary>
<returns>
<see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -3722,12 +3727,13 @@ It is recommended that a function return `1`, `0`, and `-1`, respectively.
<Parameter Name="result" Type="System.Int128" RefType="out" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="style">To be added.</param>
<param name="provider">To be added.</param>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">The span of characters to parse.</param>
<param name="style">A bitwise combination of number styles that can be present in <paramref name="s" />.</param>
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
<param name="result">On return, contains the result of successfully parsing <paramref name="s" /> or an undefined value on failure.</param>
<summary>Tries to parse a span of characters into a value.</summary>
<returns>
<see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -3760,12 +3766,13 @@ It is recommended that a function return `1`, `0`, and `-1`, respectively.
<Parameter Name="result" Type="System.Int128" RefType="out" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="style">To be added.</param>
<param name="provider">To be added.</param>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">The string to parse.</param>
<param name="style">A bitwise combination of number styles that can be present in <paramref name="s" />.</param>
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
<param name="result">On return, contains the result of successfully parsing <paramref name="s" /> or an undefined value on failure.</param>
<summary>Tries to parse a string into a value.</summary>
<returns>
<see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
Loading