Skip to content

Commit 033339c

Browse files
jkoritzinskyjkoritzinsky
authored
Add port docs for new System.Runtime.InteropServices APIs (#9204)
1 parent ef63130 commit 033339c

File tree

2 files changed

+31
-22
lines changed

2 files changed

+31
-22
lines changed

‎xml/System.Numerics/INumberBase`1.xml‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1177,10 +1177,10 @@ For <xref:System.Numerics.IFloatingPointIeee754%601> this method matches the IEE
11771177
<Parameter Name="provider" Type="System.IFormatProvider" Index="1" FrameworkAlternate="net-8.0" />
11781178
</Parameters>
11791179
<Docs>
1180-
<param name="utf8Text">To be added.</param>
1181-
<param name="provider">To be added.</param>
1182-
<summary>To be added.</summary>
1183-
<returns>To be added.</returns>
1180+
<param name="utf8Text">The span of UTF-8 characters to parse.</param>
1181+
<param name="provider">An object that provides culture-specific formatting information about <paramref name="utf8Text" />.</param>
1182+
<summary>Parses a span of UTF-8 characters into a value.</summary>
1183+
<returns>The result of parsing <paramref name="utf8Text" />.</returns>
11841184
<remarks>To be added.</remarks>
11851185
</Docs>
11861186
</Member>
@@ -1215,11 +1215,12 @@ For <xref:System.Numerics.IFloatingPointIeee754%601> this method matches the IEE
12151215
</Parameter>
12161216
</Parameters>
12171217
<Docs>
1218-
<param name="utf8Text">To be added.</param>
1219-
<param name="provider">To be added.</param>
1220-
<param name="result">To be added.</param>
1221-
<summary>To be added.</summary>
1222-
<returns>To be added.</returns>
1218+
<param name="utf8Text">The span of UTF-8 characters to parse.</param>
1219+
<param name="provider">An object that provides culture-specific formatting information about <paramref name="utf8Text" />.</param>
1220+
<param name="result">On return, contains the result of successfully parsing <paramref name="utf8Text" /> or an undefined value on failure.</param>
1221+
<summary>Tries to parse a span of UTF-8 characters into a value.</summary>
1222+
<returns>
1223+
<see langword="true" /> if <paramref name="utf8Text" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
12231224
<remarks>To be added.</remarks>
12241225
</Docs>
12251226
</Member>

‎xml/System.Runtime.InteropServices/NFloat.xml‎

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1308,6 +1308,7 @@ This computes `cos(x * π)`.
13081308
<summary>To be added.</summary>
13091309
<returns>To be added.</returns>
13101310
<remarks>To be added.</remarks>
1311+
<inheritdoc cref="M:System.Numerics.ITrigonometricFunctions`1.DegreesToRadians(`0)" />
13111312
</Docs>
13121313
</Member>
13131314
<Member MemberName="E">
@@ -4540,11 +4541,12 @@ For <xref:System.Numerics.IFloatingPoint%601> this method matches the IEEE 754:2
45404541
</Parameter>
45414542
</Parameters>
45424543
<Docs>
4543-
<param name="utf8Text">To be added.</param>
4544-
<param name="provider">To be added.</param>
4545-
<summary>To be added.</summary>
4546-
<returns>To be added.</returns>
4544+
<param name="utf8Text">The span of UTF-8 characters to parse.</param>
4545+
<param name="provider">An object that provides culture-specific formatting information about <paramref name="utf8Text" />.</param>
4546+
<summary>Parses a span of UTF-8 characters into a value.</summary>
4547+
<returns>The result of parsing <paramref name="utf8Text" />.</returns>
45474548
<remarks>To be added.</remarks>
4549+
<inheritdoc cref="M:System.IUtf8SpanParsable`1.Parse(System.ReadOnlySpan{System.Byte},System.IFormatProvider)" />
45484550
</Docs>
45494551
</Member>
45504552
<Member MemberName="Parse">
@@ -4714,6 +4716,7 @@ For <xref:System.Numerics.IFloatingPoint%601> this method matches the IEEE 754:2
47144716
<summary>To be added.</summary>
47154717
<returns>To be added.</returns>
47164718
<remarks>To be added.</remarks>
4719+
<inheritdoc cref="M:System.Numerics.INumberBase`1.Parse(System.ReadOnlySpan{System.Byte},System.Globalization.NumberStyles,System.IFormatProvider)" />
47174720
</Docs>
47184721
</Member>
47194722
<Member MemberName="Parse">
@@ -4929,6 +4932,7 @@ For <xref:System.Numerics.IFloatingPoint%601> this method matches the IEEE 754:2
49294932
<summary>To be added.</summary>
49304933
<returns>To be added.</returns>
49314934
<remarks>To be added.</remarks>
4935+
<inheritdoc cref="M:System.Numerics.ITrigonometricFunctions`1.RadiansToDegrees(`0)" />
49324936
</Docs>
49334937
</Member>
49344938
<Member MemberName="ReciprocalEstimate">
@@ -7025,10 +7029,11 @@ This computes `tan(x * π)`.
70257029
<Parameter Name="result" Type="System.Runtime.InteropServices.NFloat" RefType="out" Index="1" FrameworkAlternate="net-8.0" />
70267030
</Parameters>
70277031
<Docs>
7028-
<param name="utf8Text">To be added.</param>
7029-
<param name="result">To be added.</param>
7030-
<summary>To be added.</summary>
7031-
<returns>To be added.</returns>
7032+
<param name="utf8Text">A read-only UTF-8 character span that contains the number to convert.</param>
7033+
<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>
7034+
<summary>Tries to convert a UTF-8 character span containing the string representation of a number to its floating-point number equivalent.</summary>
7035+
<returns>
7036+
<see langword="true" /> if <paramref name="utf8Text" /> was converted successfully; otherwise, <see langword="false" />.</returns>
70327037
<remarks>To be added.</remarks>
70337038
</Docs>
70347039
</Member>
@@ -7131,12 +7136,14 @@ This computes `tan(x * π)`.
71317136
<Parameter Name="result" Type="System.Runtime.InteropServices.NFloat" RefType="out" Index="2" FrameworkAlternate="net-8.0" />
71327137
</Parameters>
71337138
<Docs>
7134-
<param name="utf8Text">To be added.</param>
7135-
<param name="provider">To be added.</param>
7136-
<param name="result">To be added.</param>
7137-
<summary>To be added.</summary>
7138-
<returns>To be added.</returns>
7139+
<param name="utf8Text">The span of UTF-8 characters to parse.</param>
7140+
<param name="provider">An object that provides culture-specific formatting information about <paramref name="utf8Text" />.</param>
7141+
<param name="result">On return, contains the result of successfully parsing <paramref name="utf8Text" /> or an undefined value on failure.</param>
7142+
<summary>Tries to parse a span of UTF-8 characters into a value.</summary>
7143+
<returns>
7144+
<see langword="true" /> if <paramref name="utf8Text" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
71397145
<remarks>To be added.</remarks>
7146+
<inheritdoc cref="M:System.IUtf8SpanParsable`1.TryParse(System.ReadOnlySpan{System.Byte},System.IFormatProvider,`0@)" />
71407147
</Docs>
71417148
</Member>
71427149
<Member MemberName="TryParse">
@@ -7259,6 +7266,7 @@ This computes `tan(x * π)`.
72597266
<summary>To be added.</summary>
72607267
<returns>To be added.</returns>
72617268
<remarks>To be added.</remarks>
7269+
<inheritdoc cref="M:System.Numerics.INumberBase`1.TryParse(System.ReadOnlySpan{System.Byte},System.Globalization.NumberStyles,System.IFormatProvider,`0@)" />
72627270
</Docs>
72637271
</Member>
72647272
<Member MemberName="TryParse">

0 commit comments

Comments
 (0)