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
carlossanlop 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 1 commit
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
Prev Previous commit
Next Next commit
Fix documentation for UInt128/Int128.TryParse
  • Loading branch information
@dakersnar
dakersnar committed Sep 19, 2022
commit b36b282c69a74c6d9fa514813b34f4ff5230781d
56 changes: 30 additions & 26 deletions xml/System/Int128.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3594,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 @@ -3628,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 @@ -3656,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 @@ -3696,8 +3698,8 @@ It is recommended that a function return `1`, `0`, and `-1`, respectively.
<Docs>
<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>
<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 @@ -3725,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 @@ -3763,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
56 changes: 30 additions & 26 deletions xml/System/UInt128.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3488,10 +3488,11 @@ It is recommended that a function return `1`, `0`, and `-1`, respectively.
<Parameter Name="result" Type="System.UInt128" 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 @@ -3522,10 +3523,11 @@ It is recommended that a function return `1`, `0`, and `-1`, respectively.
<Parameter Name="result" Type="System.UInt128" 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 @@ -3550,10 +3552,10 @@ It is recommended that a function return `1`, `0`, and `-1`, respectively.
<Parameter Name="result" Type="System.UInt128" 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 @@ -3590,8 +3592,8 @@ It is recommended that a function return `1`, `0`, and `-1`, respectively.
<Docs>
<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>
<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 @@ -3619,12 +3621,13 @@ It is recommended that a function return `1`, `0`, and `-1`, respectively.
<Parameter Name="result" Type="System.UInt128" 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 @@ -3657,12 +3660,13 @@ It is recommended that a function return `1`, `0`, and `-1`, respectively.
<Parameter Name="result" Type="System.UInt128" 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