Skip to content

Commit e53f388

Browse files
carlossanlopcarlossanlop
authored
Port System new docs (second pass) (#10213)
* System (C-H) * System (I-S) * System (T-V)
1 parent c2c91fc commit e53f388

24 files changed

+431
-425
lines changed

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1435,7 +1435,7 @@ This computes `cos(x * π)`.
14351435
<Docs>
14361436
<param name="degrees">The value to convert to radians.</param>
14371437
<summary>Converts a given value from degrees to radians.</summary>
1438-
<returns>The value of <see paramref="degrees" /> converted to radians.</returns>
1438+
<returns>The value of <paramref name="degrees" /> converted to radians.</returns>
14391439
<remarks>To be added.</remarks>
14401440
<inheritdoc cref="M:System.Numerics.ITrigonometricFunctions`1.DegreesToRadians(`0)" />
14411441
</Docs>
@@ -4980,10 +4980,10 @@ For <xref:System.Numerics.IFloatingPoint%601> this method matches the IEEE 754:2
49804980
</Parameters>
49814981
<Docs>
49824982
<param name="utf8Text">The span of UTF-8 characters to parse.</param>
4983-
<param name="style">A bitwise combination of number styles that can be present in <see paramref="utf8Text" />.</param>
4984-
<param name="provider">An object that provides culture-specific formatting information about <see paramref="utf8Text" />.</param>
4983+
<param name="style">A bitwise combination of number styles that can be present in <paramref name="utf8Text" />.</param>
4984+
<param name="provider">An object that provides culture-specific formatting information about <paramref name="utf8Text" />.</param>
49854985
<summary>Parses a span of UTF-8 characters into a value.</summary>
4986-
<returns>The result of parsing <see paramref="utf8Text" />.</returns>
4986+
<returns>The result of parsing <paramref name="utf8Text" />.</returns>
49874987
<remarks>To be added.</remarks>
49884988
<inheritdoc cref="M:System.Numerics.INumberBase`1.Parse(System.ReadOnlySpan{System.Byte},System.Globalization.NumberStyles,System.IFormatProvider)" />
49894989
</Docs>
@@ -5205,7 +5205,7 @@ For <xref:System.Numerics.IFloatingPoint%601> this method matches the IEEE 754:2
52055205
<Docs>
52065206
<param name="radians">The value to convert to degrees.</param>
52075207
<summary>Converts a given value from radians to degrees.</summary>
5208-
<returns>The value of <see paramref="radians" /> converted to degrees.</returns>
5208+
<returns>The value of <paramref name="radians" /> converted to degrees.</returns>
52095209
<remarks>To be added.</remarks>
52105210
<inheritdoc cref="M:System.Numerics.ITrigonometricFunctions`1.RadiansToDegrees(`0)" />
52115211
</Docs>
@@ -7605,12 +7605,12 @@ This computes `tan(x * π)`.
76057605
</Parameters>
76067606
<Docs>
76077607
<param name="utf8Text">The span of UTF-8 characters to parse.</param>
7608-
<param name="style">A bitwise combination of number styles that can be present in <see paramref="utf8Text" />.</param>
7609-
<param name="provider">An object that provides culture-specific formatting information about <see paramref="utf8Text" />.</param>
7610-
<param name="result">On return, contains the result of successfully parsing <see paramref="utf8Text" /> or an undefined value on failure.</param>
7608+
<param name="style">A bitwise combination of number styles that can be present in <paramref name="utf8Text" />.</param>
7609+
<param name="provider">An object that provides culture-specific formatting information about <paramref name="utf8Text" />.</param>
7610+
<param name="result">On return, contains the result of successfully parsing <paramref name="utf8Text" /> or an undefined value on failure.</param>
76117611
<summary>Tries to parse a span of UTF-8 characters into a value.</summary>
76127612
<returns>
7613-
<see langword="true" /> if <see paramref="utf8Text" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
7613+
<see langword="true" /> if <paramref name="utf8Text" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
76147614
<remarks>To be added.</remarks>
76157615
<inheritdoc cref="M:System.Numerics.INumberBase`1.TryParse(System.ReadOnlySpan{System.Byte},System.Globalization.NumberStyles,System.IFormatProvider,`0@)" />
76167616
</Docs>

‎xml/System/Char.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5813,12 +5813,12 @@ This member is an explicit interface member implementation. It can be used only
58135813
</Parameters>
58145814
<Docs>
58155815
<param name="utf8Destination">The span in which to write this instance's value formatted as a span of bytes.</param>
5816-
<param name="bytesWritten">When this method returns, contains the number of bytes that were written in <code data-dev-comment-type="paramref">utf8Destination</code>.</param>
5817-
<param name="format">A span containing the characters that represent a standard or custom format string that defines the acceptable format for <code data-dev-comment-type="paramref">utf8Destination</code>.</param>
5818-
<param name="provider">An optional object that supplies culture-specific formatting information for <code data-dev-comment-type="paramref">utf8Destination</code>.</param>
5816+
<param name="bytesWritten">When this method returns, contains the number of bytes that were written in <paramref name="utf8Destination" />.</param>
5817+
<param name="format">A span containing the characters that represent a standard or custom format string that defines the acceptable format for <paramref name="utf8Destination" />.</param>
5818+
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="utf8Destination" />.</param>
58195819
<summary>Tries to format the value of the current instance as UTF-8 into the provided span of bytes.</summary>
58205820
<returns>
5821-
<code data-dev-comment-type="langword">true</code> if the formatting was successful; otherwise, <code data-dev-comment-type="langword">false</code>.</returns>
5821+
<see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
58225822
<remarks>To be added.</remarks>
58235823
<inheritdoc cref="M:System.IUtf8SpanFormattable.TryFormat(System.Span{System.Byte},System.Int32@,System.ReadOnlySpan{System.Char},System.IFormatProvider)" />
58245824
</Docs>

‎xml/System/DateOnly.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1730,12 +1730,12 @@
17301730
</Parameters>
17311731
<Docs>
17321732
<param name="utf8Destination">The span in which to write this instance's value formatted as a span of bytes.</param>
1733-
<param name="bytesWritten">When this method returns, contains the number of bytes that were written in <code data-dev-comment-type="paramref">utf8Destination</code>.</param>
1734-
<param name="format">A span containing the characters that represent a standard or custom format string that defines the acceptable format for <code data-dev-comment-type="paramref">utf8Destination</code>.</param>
1735-
<param name="provider">An optional object that supplies culture-specific formatting information for <code data-dev-comment-type="paramref">utf8Destination</code>.</param>
1733+
<param name="bytesWritten">When this method returns, contains the number of bytes that were written in <paramref name="utf8Destination" />.</param>
1734+
<param name="format">A span containing the characters that represent a standard or custom format string that defines the acceptable format for <paramref name="utf8Destination" />.</param>
1735+
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="utf8Destination" />.</param>
17361736
<summary>Tries to format the value of the current instance as UTF-8 into the provided span of bytes.</summary>
17371737
<returns>
1738-
<code data-dev-comment-type="langword">true</code> if the formatting was successful; otherwise, <code data-dev-comment-type="langword">false</code>.</returns>
1738+
<see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
17391739
<remarks>To be added.</remarks>
17401740
<inheritdoc cref="M:System.IUtf8SpanFormattable.TryFormat(System.Span{System.Byte},System.Int32@,System.ReadOnlySpan{System.Char},System.IFormatProvider)" />
17411741
</Docs>

‎xml/System/DateTimeOffset.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6661,12 +6661,12 @@ Me.ToUtcDateTime().ToFileTime()
66616661
</Parameters>
66626662
<Docs>
66636663
<param name="utf8Destination">The span in which to write this instance's value formatted as a span of bytes.</param>
6664-
<param name="bytesWritten">When this method returns, contains the number of bytes that were written in <code data-dev-comment-type="paramref">utf8Destination</code>.</param>
6665-
<param name="format">A span containing the characters that represent a standard or custom format string that defines the acceptable format for <code data-dev-comment-type="paramref">utf8Destination</code>.</param>
6664+
<param name="bytesWritten">When this method returns, contains the number of bytes that were written in <paramref name="utf8Destination" />.</param>
6665+
<param name="format">A span containing the characters that represent a standard or custom format string that defines the acceptable format for <paramref name="utf8Destination" />.</param>
66666666
<param name="formatProvider">To be added.</param>
66676667
<summary>Tries to format the value of the current instance as UTF-8 into the provided span of bytes.</summary>
66686668
<returns>
6669-
<code data-dev-comment-type="langword">true</code> if the formatting was successful; otherwise, <code data-dev-comment-type="langword">false</code>.</returns>
6669+
<see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
66706670
<remarks>To be added.</remarks>
66716671
<inheritdoc cref="M:System.IUtf8SpanFormattable.TryFormat(System.Span{System.Byte},System.Int32@,System.ReadOnlySpan{System.Char},System.IFormatProvider)" />
66726672
</Docs>

‎xml/System/Decimal.xml

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6090,9 +6090,9 @@ For <xref:System.Numerics.IFloatingPointIeee754%601>, this method matches the IE
60906090
</Parameters>
60916091
<Docs>
60926092
<param name="utf8Text">The span of UTF-8 characters to parse.</param>
6093-
<param name="provider">An object that provides culture-specific formatting information about <code data-dev-comment-type="paramref">utf8Text</code>.</param>
6093+
<param name="provider">An object that provides culture-specific formatting information about <paramref name="utf8Text" />.</param>
60946094
<summary>Parses a span of UTF-8 characters into a value.</summary>
6095-
<returns>The result of parsing <code data-dev-comment-type="paramref">utf8Text</code>.</returns>
6095+
<returns>The result of parsing <paramref name="utf8Text" />.</returns>
60966096
<remarks>To be added.</remarks>
60976097
<inheritdoc cref="M:System.IUtf8SpanParsable`1.Parse(System.ReadOnlySpan{System.Byte},System.IFormatProvider)" />
60986098
</Docs>
@@ -6432,10 +6432,10 @@ For <xref:System.Numerics.IFloatingPointIeee754%601>, this method matches the IE
64326432
</Parameters>
64336433
<Docs>
64346434
<param name="utf8Text">The span of UTF-8 characters to parse.</param>
6435-
<param name="style">A bitwise combination of number styles that can be present in <code data-dev-comment-type="paramref">utf8Text</code>.</param>
6436-
<param name="provider">An object that provides culture-specific formatting information about <code data-dev-comment-type="paramref">utf8Text</code>.</param>
6435+
<param name="style">A bitwise combination of number styles that can be present in <paramref name="utf8Text" />.</param>
6436+
<param name="provider">An object that provides culture-specific formatting information about <paramref name="utf8Text" />.</param>
64376437
<summary>Parses a span of UTF-8 characters into a value.</summary>
6438-
<returns>The result of parsing <code data-dev-comment-type="paramref">utf8Text</code>.</returns>
6438+
<returns>The result of parsing <paramref name="utf8Text" />.</returns>
64396439
<remarks>To be added.</remarks>
64406440
<inheritdoc cref="M:System.Numerics.INumberBase`1.Parse(System.ReadOnlySpan{System.Byte},System.Globalization.NumberStyles,System.IFormatProvider)" />
64416441
</Docs>
@@ -11124,12 +11124,12 @@ This member is an explicit interface member implementation. It can be used only
1112411124
</Parameters>
1112511125
<Docs>
1112611126
<param name="utf8Destination">The span in which to write this instance's value formatted as a span of bytes.</param>
11127-
<param name="bytesWritten">When this method returns, contains the number of bytes that were written in <code data-dev-comment-type="paramref">utf8Destination</code>.</param>
11128-
<param name="format">A span containing the characters that represent a standard or custom format string that defines the acceptable format for <code data-dev-comment-type="paramref">utf8Destination</code>.</param>
11129-
<param name="provider">An optional object that supplies culture-specific formatting information for <code data-dev-comment-type="paramref">utf8Destination</code>.</param>
11127+
<param name="bytesWritten">When this method returns, contains the number of bytes that were written in <paramref name="utf8Destination" />.</param>
11128+
<param name="format">A span containing the characters that represent a standard or custom format string that defines the acceptable format for <paramref name="utf8Destination" />.</param>
11129+
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="utf8Destination" />.</param>
1113011130
<summary>Tries to format the value of the current instance as UTF-8 into the provided span of bytes.</summary>
1113111131
<returns>
11132-
<code data-dev-comment-type="langword">true</code> if the formatting was successful; otherwise, <code data-dev-comment-type="langword">false</code>.</returns>
11132+
<see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
1113311133
<remarks>To be added.</remarks>
1113411134
<inheritdoc cref="M:System.IUtf8SpanFormattable.TryFormat(System.Span{System.Byte},System.Int32@,System.ReadOnlySpan{System.Char},System.IFormatProvider)" />
1113511135
</Docs>
@@ -11478,11 +11478,11 @@ This member is an explicit interface member implementation. It can be used only
1147811478
</Parameters>
1147911479
<Docs>
1148011480
<param name="utf8Text">The span of UTF-8 characters to parse.</param>
11481-
<param name="provider">An object that provides culture-specific formatting information about <code data-dev-comment-type="paramref">utf8Text</code>.</param>
11482-
<param name="result">On return, contains the result of successfully parsing <code data-dev-comment-type="paramref">utf8Text</code> or an undefined value on failure.</param>
11481+
<param name="provider">An object that provides culture-specific formatting information about <paramref name="utf8Text" />.</param>
11482+
<param name="result">On return, contains the result of successfully parsing <paramref name="utf8Text" /> or an undefined value on failure.</param>
1148311483
<summary>Tries to parse a span of UTF-8 characters into a value.</summary>
1148411484
<returns>
11485-
<code data-dev-comment-type="langword">true</code> if <code data-dev-comment-type="paramref">utf8Text</code> was successfully parsed; otherwise, <code data-dev-comment-type="langword">false</code>.</returns>
11485+
<see langword="true" /> if <paramref name="utf8Text" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
1148611486
<remarks>To be added.</remarks>
1148711487
<inheritdoc cref="M:System.IUtf8SpanParsable`1.TryParse(System.ReadOnlySpan{System.Byte},System.IFormatProvider,`0@)" />
1148811488
</Docs>
@@ -11622,12 +11622,12 @@ This member is an explicit interface member implementation. It can be used only
1162211622
</Parameters>
1162311623
<Docs>
1162411624
<param name="utf8Text">The span of UTF-8 characters to parse.</param>
11625-
<param name="style">A bitwise combination of number styles that can be present in <code data-dev-comment-type="paramref">utf8Text</code>.</param>
11626-
<param name="provider">An object that provides culture-specific formatting information about <code data-dev-comment-type="paramref">utf8Text</code>.</param>
11627-
<param name="result">On return, contains the result of successfully parsing <code data-dev-comment-type="paramref">utf8Text</code> or an undefined value on failure.</param>
11625+
<param name="style">A bitwise combination of number styles that can be present in <paramref name="utf8Text" />.</param>
11626+
<param name="provider">An object that provides culture-specific formatting information about <paramref name="utf8Text" />.</param>
11627+
<param name="result">On return, contains the result of successfully parsing <paramref name="utf8Text" /> or an undefined value on failure.</param>
1162811628
<summary>Tries to parse a span of UTF-8 characters into a value.</summary>
1162911629
<returns>
11630-
<code data-dev-comment-type="langword">true</code> if <code data-dev-comment-type="paramref">utf8Text</code> was successfully parsed; otherwise, <code data-dev-comment-type="langword">false</code>.</returns>
11630+
<see langword="true" /> if <paramref name="utf8Text" /> was successfully parsed; otherwise, <see langword="false" />.</returns>
1163111631
<remarks>To be added.</remarks>
1163211632
<inheritdoc cref="M:System.Numerics.INumberBase`1.TryParse(System.ReadOnlySpan{System.Byte},System.Globalization.NumberStyles,System.IFormatProvider,`0@)" />
1163311633
</Docs>

0 commit comments

Comments
 (0)