Skip to content

Commit

Permalink
Add port docs for new System.Runtime.InteropServices APIs (#9204)
Browse files Browse the repository at this point in the history
  • Loading branch information
@jkoritzinsky
jkoritzinsky authored Aug 21, 2023
1 parent ef63130 commit 033339c
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 22 deletions.
19 changes: 10 additions & 9 deletions xml/System.Numerics/INumberBase`1.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1177,10 +1177,10 @@ For <xref:System.Numerics.IFloatingPointIeee754%601> this method matches the IEE
<Parameter Name="provider" Type="System.IFormatProvider" Index="1" FrameworkAlternate="net-8.0" />
</Parameters>
<Docs>
<param name="utf8Text">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="utf8Text">The span of UTF-8 characters to parse.</param>
<param name="provider">An object that provides culture-specific formatting information about <paramref name="utf8Text" />.</param>
<summary>Parses a span of UTF-8 characters into a value.</summary>
<returns>The result of parsing <paramref name="utf8Text" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1215,11 +1215,12 @@ For <xref:System.Numerics.IFloatingPointIeee754%601> this method matches the IEE
</Parameter>
</Parameters>
<Docs>
<param name="utf8Text">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="utf8Text">The span of UTF-8 characters to parse.</param>
<param name="provider">An object that provides culture-specific formatting information about <paramref name="utf8Text" />.</param>
<param name="result">On return, contains the result of successfully parsing <paramref name="utf8Text" /> or an undefined value on failure.</param>
<summary>Tries to parse a span of UTF-8 characters into a value.</summary>
<returns>
<see langword="true" /> if <paramref name="utf8Text" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
34 changes: 21 additions & 13 deletions xml/System.Runtime.InteropServices/NFloat.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1308,6 +1308,7 @@ This computes `cos(x * π)`.
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Numerics.ITrigonometricFunctions`1.DegreesToRadians(`0)" />
</Docs>
</Member>
<Member MemberName="E">
Expand Down Expand Up @@ -4540,11 +4541,12 @@ For <xref:System.Numerics.IFloatingPoint%601> this method matches the IEEE 754:2
</Parameter>
</Parameters>
<Docs>
<param name="utf8Text">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="utf8Text">The span of UTF-8 characters to parse.</param>
<param name="provider">An object that provides culture-specific formatting information about <paramref name="utf8Text" />.</param>
<summary>Parses a span of UTF-8 characters into a value.</summary>
<returns>The result of parsing <paramref name="utf8Text" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.IUtf8SpanParsable`1.Parse(System.ReadOnlySpan{System.Byte},System.IFormatProvider)" />
</Docs>
</Member>
<Member MemberName="Parse">
Expand Down Expand Up @@ -4714,6 +4716,7 @@ For <xref:System.Numerics.IFloatingPoint%601> this method matches the IEEE 754:2
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Numerics.INumberBase`1.Parse(System.ReadOnlySpan{System.Byte},System.Globalization.NumberStyles,System.IFormatProvider)" />
</Docs>
</Member>
<Member MemberName="Parse">
Expand Down Expand Up @@ -4929,6 +4932,7 @@ For <xref:System.Numerics.IFloatingPoint%601> this method matches the IEEE 754:2
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Numerics.ITrigonometricFunctions`1.RadiansToDegrees(`0)" />
</Docs>
</Member>
<Member MemberName="ReciprocalEstimate">
Expand Down Expand Up @@ -7025,10 +7029,11 @@ This computes `tan(x * π)`.
<Parameter Name="result" Type="System.Runtime.InteropServices.NFloat" RefType="out" Index="1" FrameworkAlternate="net-8.0" />
</Parameters>
<Docs>
<param name="utf8Text">To be added.</param>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="utf8Text">A read-only UTF-8 character span that contains the number to convert.</param>
<param name="result">When this method returns, contains a floating-point number equivalent of the numeric value or symbol contained in <paramref name="utf8Text" /> if the conversion succeeded or zero if the conversion failed. The conversion fails if the <paramref name="utf8Text" /> is <see cref="P:System.ReadOnlySpan`1.Empty" /> or is not in a valid format. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.</param>
<summary>Tries to convert a UTF-8 character span containing the string representation of a number to its floating-point number equivalent.</summary>
<returns>
<see langword="true" /> if <paramref name="utf8Text" /> was converted successfully; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -7131,12 +7136,14 @@ This computes `tan(x * π)`.
<Parameter Name="result" Type="System.Runtime.InteropServices.NFloat" RefType="out" Index="2" FrameworkAlternate="net-8.0" />
</Parameters>
<Docs>
<param name="utf8Text">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="utf8Text">The span of UTF-8 characters to parse.</param>
<param name="provider">An object that provides culture-specific formatting information about <paramref name="utf8Text" />.</param>
<param name="result">On return, contains the result of successfully parsing <paramref name="utf8Text" /> or an undefined value on failure.</param>
<summary>Tries to parse a span of UTF-8 characters into a value.</summary>
<returns>
<see langword="true" /> if <paramref name="utf8Text" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.IUtf8SpanParsable`1.TryParse(System.ReadOnlySpan{System.Byte},System.IFormatProvider,`0@)" />
</Docs>
</Member>
<Member MemberName="TryParse">
Expand Down Expand Up @@ -7259,6 +7266,7 @@ This computes `tan(x * π)`.
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Numerics.INumberBase`1.TryParse(System.ReadOnlySpan{System.Byte},System.Globalization.NumberStyles,System.IFormatProvider,`0@)" />
</Docs>
</Member>
<Member MemberName="TryParse">
Expand Down

0 comments on commit 033339c

Please sign in to comment.