Skip to content

Fix api documentation for System/System.Numerics #8423

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
merged 28 commits into from
Sep 27, 2022
Merged

Fix api documentation for System/System.Numerics #8423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 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
e5275ec
Merge branch 'main' of https://github.com/dotnet/dotnet-api-docs into…
dakersnar Sep 21, 2022
1d7ce76
Fix error with Decimal.Sign param
dakersnar Sep 21, 2022
fa1c65d
Fix documentation for System types
dakersnar Sep 23, 2022
a9459a2
Fix BigInteger.TryParse docs
dakersnar Sep 23, 2022
3c93df1
Fix IBinaryInteger documentation
dakersnar Sep 23, 2022
89937dc
Fix NFloat.TryParse documentation
dakersnar Sep 23, 2022
2cd014b
Fix *.Item documentation issues
dakersnar Sep 23, 2022
893c8cc
Fix 'Tries to parses' typo
dakersnar Sep 23, 2022
5d4041f
Merge branch 'main' of https://github.com/dotnet/dotnet-api-docs into…
dakersnar Sep 23, 2022
f1df7d4
Update xml/System.Numerics/Matrix3x2.xml
dakersnar Sep 26, 2022
6a75b65
Update xml/System.Numerics/Matrix4x4.xml
dakersnar Sep 26, 2022
8e3fd8f
Update xml/System.Numerics/Matrix3x2.xml
dakersnar Sep 26, 2022
ba63bba
Update xml/System.Numerics/Matrix4x4.xml
dakersnar Sep 26, 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
1 change: 1 addition & 0 deletions xml/System.Numerics/BigInteger.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10105,6 +10105,7 @@ The integer value `33022` can be exported in four different arrays:
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.IParsable`1.TryParse(System.String,System.IFormatProvider,`0@)" />
</Docs>
</Member>
<Member MemberName="TryParse">
Expand Down
4 changes: 2 additions & 2 deletions xml/System.Numerics/INumberBase`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1285,7 +1285,7 @@ For <xref:System.Numerics.IFloatingPointIeee754%601> this method matches the IEE
<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 succesfully parsing <paramref name="s" /> or an undefined value on failure.</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 @@ -1326,7 +1326,7 @@ For <xref:System.Numerics.IFloatingPointIeee754%601> this method matches the IEE
<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 succesfully parsing <paramref name="s" /> or an undefined value on failure.</param>
<summary>Tries to parses a string into a value.</summary>
<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
12 changes: 8 additions & 4 deletions xml/System.Numerics/Matrix3x2.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1125,11 +1125,15 @@
<Parameter Name="column" Type="System.Int32" Index="1" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="row">To be added.</param>
<param name="column">To be added.</param>
<summary>To be added.</summary>
<value>To be added.</value>
<param name="row">The index of the row containing the element to get or set.</param>
<param name="column">The index of the column containing the element to get or set.</param>
<summary>Gets or sets the element at the specified indices.</summary>
<value>The element at [<paramref name="row" />][<paramref name="column" />].</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<para><paramref name="row" /> was less than zero or greater than the number of rows.</para>
<para>-or-</para>
<para><paramref name="column" /> was less than zero or greater than the number of columns.</para></exception>
</Docs>
</Member>
<Member MemberName="Lerp">
Expand Down
12 changes: 8 additions & 4 deletions xml/System.Numerics/Matrix4x4.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2058,11 +2058,15 @@
<Parameter Name="column" Type="System.Int32" Index="1" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="row">To be added.</param>
<param name="column">To be added.</param>
<summary>To be added.</summary>
<value>To be added.</value>
<param name="row">The index of the row containing the element to get or set.</param>
<param name="column">The index of the column containing the element to get or set.</param>
<summary>Gets or sets the element at the specified indices.</summary>
<value>The element at [<paramref name="row" />][<paramref name="column" />].</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<para><paramref name="row" /> was less than zero or greater than the number of rows.</para>
<para>-or-</para>
<para><paramref name="column" /> was less than zero or greater than the number of columns.</para></exception>
</Docs>
</Member>
<Member MemberName="Lerp">
Expand Down
8 changes: 5 additions & 3 deletions xml/System.Numerics/Quaternion.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -859,10 +859,12 @@ w = cos(theta/2)
<Parameter Name="index" Type="System.Int32" Index="0" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<summary>To be added.</summary>
<value>To be added.</value>
<param name="index">The index of the element to get or set.</param>
<summary>Gets or sets the element at the specified index.</summary>
<value>The element at <paramref name="index" />.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index" /> was less than zero or greater than the number of elements.</exception>
</Docs>
</Member>
<Member MemberName="Length">
Expand Down
8 changes: 5 additions & 3 deletions xml/System.Numerics/Vector2.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -942,10 +942,12 @@
<Parameter Name="index" Type="System.Int32" Index="0" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<summary>To be added.</summary>
<value>To be added.</value>
<param name="index">The index of the element to get or set.</param>
<summary>Gets or sets the element at the specified index.</summary>
<value>The the element at <paramref name="index" />.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index" /> was less than zero or greater than the number of elements.</exception>
</Docs>
</Member>
<Member MemberName="Length">
Expand Down
8 changes: 5 additions & 3 deletions xml/System.Numerics/Vector3.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1030,10 +1030,12 @@
<Parameter Name="index" Type="System.Int32" Index="0" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<summary>To be added.</summary>
<value>To be added.</value>
<param name="index">The index of the element to get or set.</param>
<summary>Gets or sets the element at the specified index.</summary>
<value>The the element at <paramref name="index" />.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index" /> was less than zero or greater than the number of elements.</exception>
</Docs>
</Member>
<Member MemberName="Length">
Expand Down
8 changes: 5 additions & 3 deletions xml/System.Numerics/Vector4.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1030,10 +1030,12 @@
<Parameter Name="index" Type="System.Int32" Index="0" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<summary>To be added.</summary>
<value>To be added.</value>
<param name="index">The index of the element to get or set.</param>
<summary>Gets or sets the element at the specified index.</summary>
<value>The the element at <paramref name="index" />.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index" /> was less than zero or greater than the number of elements.</exception>
</Docs>
</Member>
<Member MemberName="Length">
Expand Down
3 changes: 2 additions & 1 deletion xml/System.Runtime.InteropServices/NFloat.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5673,7 +5673,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 @@ -5714,6 +5714,7 @@ This computes `tan(x * π)`.
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.IParsable`1.TryParse(System.String,System.IFormatProvider,`0@)" />
</Docs>
</Member>
<Member MemberName="TryParse">
Expand Down
4 changes: 2 additions & 2 deletions xml/System/Byte.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3779,7 +3779,7 @@ This member is an explicit interface member implementation. It can be used only
<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 @@ -3823,7 +3823,7 @@ This member is an explicit interface member implementation. It can be used only
<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>
<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
4 changes: 2 additions & 2 deletions xml/System/DateOnly.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1504,7 +1504,7 @@
<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 @@ -1542,7 +1542,7 @@
<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 string into a value.</summary>
<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
4 changes: 2 additions & 2 deletions xml/System/DateTime.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9528,7 +9528,7 @@ The following example illustrates how the string representation of a <xref:Syste
<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 @@ -9572,7 +9572,7 @@ The following example illustrates how the string representation of a <xref:Syste
<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 string into a value.</summary>
<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
4 changes: 2 additions & 2 deletions xml/System/DateTimeOffset.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6421,7 +6421,7 @@ Me.ToUtcDateTime().ToFileTime()
<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 @@ -6465,7 +6465,7 @@ Me.ToUtcDateTime().ToFileTime()
<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 string into a value.</summary>
<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
9 changes: 5 additions & 4 deletions xml/System/Decimal.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6599,9 +6599,9 @@ 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="value">The value whose sign is to be computed.</param>
<param name="d">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>
<returns>A positive value if <paramref name="d" /> is positive, <see cref="P:System.Numerics.INumberBase`1.Zero" /> if <paramref name="d" /> is zero, and a negative value if <paramref name="d" /> is negative.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

Expand Down Expand Up @@ -9536,7 +9536,7 @@ This member is an explicit interface member implementation. It can be used only
<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 @@ -9580,10 +9580,11 @@ This member is an explicit interface member implementation. It can be used only
<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>
<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>
<inheritdoc cref="M:System.IParsable`1.TryParse(System.String,System.IFormatProvider,`0@)" />
</Docs>
</Member>
<Member MemberName="TryParse">
Expand Down
5 changes: 3 additions & 2 deletions xml/System/Double.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7945,7 +7945,7 @@ If a separator is encountered in the `s` parameter during a parse operation, and
<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 @@ -7989,10 +7989,11 @@ If a separator is encountered in the `s` parameter during a parse operation, and
<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>
<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>
<inheritdoc cref="M:System.IParsable`1.TryParse(System.String,System.IFormatProvider,`0@)" />
</Docs>
</Member>
<Member MemberName="TryParse">
Expand Down
4 changes: 2 additions & 2 deletions xml/System/Guid.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2289,7 +2289,7 @@ Because the `provider` parameter is ignored, you cannot use it to provide a cust
<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 @@ -2333,7 +2333,7 @@ Because the `provider` parameter is ignored, you cannot use it to provide a cust
<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 string into a value.</summary>
<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
1 change: 1 addition & 0 deletions xml/System/Half.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5707,6 +5707,7 @@ This computes `tan(x * π)`.
<returns>
<see langword="true" /> if <paramref name="s" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.IParsable`1.TryParse(System.String,System.IFormatProvider,`0@)" />
</Docs>
</Member>
<Member MemberName="TryParse">
Expand Down
2 changes: 1 addition & 1 deletion xml/System/IParsable`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@
<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>
<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
2 changes: 1 addition & 1 deletion xml/System/ISpanParsable`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
<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>
<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 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
Loading