Skip to content

Commit 21887c1

Browse files
carlossanlopRon Petrusha
carlossanlop
authored and
Ron Petrusha
committed
Document System.String (#2818)
* Document System.String * Suggestion by rpetrusha
1 parent e1cee37 commit 21887c1

File tree

1 file changed

+51
-42
lines changed

1 file changed

+51
-42
lines changed

‎xml/System/String.xml

Lines changed: 51 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -3557,10 +3557,10 @@ You can download the [Sorting Weight Tables](https://www.microsoft.com/download/
35573557
<Parameter Name="str1" Type="System.ReadOnlySpan&lt;System.Char&gt;" Index="1" FrameworkAlternate="netcore-3.0" />
35583558
</Parameters>
35593559
<Docs>
3560-
<param name="str0">To be added.</param>
3561-
<param name="str1">To be added.</param>
3562-
<summary>To be added.</summary>
3563-
<returns>To be added.</returns>
3560+
<param name="str0">The first read-only character span to concatenate.</param>
3561+
<param name="str1">The second read-only character span to concatenate.</param>
3562+
<summary>Concatenates the string representations of two specified read-only character spans.</summary>
3563+
<returns>The concatenated string representations of the values of <paramref name="str0" /> and <paramref name="str1" />.</returns>
35643564
<remarks>To be added.</remarks>
35653565
</Docs>
35663566
</Member>
@@ -3723,11 +3723,11 @@ You can download the [Sorting Weight Tables](https://www.microsoft.com/download/
37233723
<Parameter Name="str2" Type="System.ReadOnlySpan&lt;System.Char&gt;" Index="2" FrameworkAlternate="netcore-3.0" />
37243724
</Parameters>
37253725
<Docs>
3726-
<param name="str0">To be added.</param>
3727-
<param name="str1">To be added.</param>
3728-
<param name="str2">To be added.</param>
3729-
<summary>To be added.</summary>
3730-
<returns>To be added.</returns>
3726+
<param name="str0">The first read-only character span to concatenate.</param>
3727+
<param name="str1">The second read-only character span to concatenate.</param>
3728+
<param name="str2">The third read-only character span to concatenate.</param>
3729+
<summary>Concatenates the string representations of three specified read-only character spans.</summary>
3730+
<returns>The concatenated string representations of the values of <paramref name="str0" />, <paramref name="str1" /> and <paramref name="str2" />.</returns>
37313731
<remarks>To be added.</remarks>
37323732
</Docs>
37333733
</Member>
@@ -3901,12 +3901,12 @@ You can download the [Sorting Weight Tables](https://www.microsoft.com/download/
39013901
<Parameter Name="str3" Type="System.ReadOnlySpan&lt;System.Char&gt;" Index="3" FrameworkAlternate="netcore-3.0" />
39023902
</Parameters>
39033903
<Docs>
3904-
<param name="str0">To be added.</param>
3905-
<param name="str1">To be added.</param>
3906-
<param name="str2">To be added.</param>
3907-
<param name="str3">To be added.</param>
3908-
<summary>To be added.</summary>
3909-
<returns>To be added.</returns>
3904+
<param name="str0">The first read-only character span to concatenate.</param>
3905+
<param name="str1">The second read-only character span to concatenate.</param>
3906+
<param name="str2">The third read-only character span to concatenate.</param>
3907+
<param name="str3">The fourth read-only character span to concatenate.</param>
3908+
<summary>Concatenates the string representations of four specified read-only character spans.</summary>
3909+
<returns>The concatenated string representations of the values of <paramref name="str0" />, <paramref name="str1" />, <paramref name="str2" /> and <paramref name="str3" />.</returns>
39103910
<remarks>To be added.</remarks>
39113911
</Docs>
39123912
</Member>
@@ -4073,9 +4073,9 @@ You can download the [Sorting Weight Tables](https://www.microsoft.com/download/
40734073
<Parameter Name="value" Type="System.Char" Index="0" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
40744074
</Parameters>
40754075
<Docs>
4076-
<param name="value">To be added.</param>
4077-
<summary>To be added.</summary>
4078-
<returns>To be added.</returns>
4076+
<param name="value">The character to seek.</param>
4077+
<summary>Returns a value indicating whether a specified character occurs within this string.</summary>
4078+
<returns><see langword="true" /> if the <paramref name="value" /> parameter occurs within this string; otherwise, <see langword="false" />.</returns>
40794079
<remarks>To be added.</remarks>
40804080
</Docs>
40814081
</Member>
@@ -4121,8 +4121,7 @@ You can download the [Sorting Weight Tables](https://www.microsoft.com/download/
41214121
<Docs>
41224122
<param name="value">The string to seek.</param>
41234123
<summary>Returns a value indicating whether a specified substring occurs within this string.</summary>
4124-
<returns>
4125-
<see langword="true" /> if the <paramref name="value" /> parameter occurs within this string, or if <paramref name="value" /> is the empty string (""); otherwise, <see langword="false" />.</returns>
4124+
<returns><see langword="true" /> if the <paramref name="value" /> parameter occurs within this string, or if <paramref name="value" /> is the empty string (""); otherwise, <see langword="false" />.</returns>
41264125
<remarks>
41274126
<format type="text/markdown"><![CDATA[
41284127

@@ -4185,10 +4184,10 @@ You can download the [Sorting Weight Tables](https://www.microsoft.com/download/
41854184
<Parameter Name="comparisonType" Type="System.StringComparison" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
41864185
</Parameters>
41874186
<Docs>
4188-
<param name="value">To be added.</param>
4189-
<param name="comparisonType">To be added.</param>
4190-
<summary>To be added.</summary>
4191-
<returns>To be added.</returns>
4187+
<param name="value">The character to seek.</param>
4188+
<param name="comparisonType">One of the enumeration values that specifies the rules to use in the comparison.</param>
4189+
<summary>Returns a value indicating whether a specified character occurs within this string, using the specified comparison rules.</summary>
4190+
<returns><see langword="true" /> if the <paramref name="value" /> parameter occurs within this string; otherwise, <see langword="false" />.</returns>
41924191
<remarks>To be added.</remarks>
41934192
</Docs>
41944193
</Member>
@@ -4219,10 +4218,10 @@ You can download the [Sorting Weight Tables](https://www.microsoft.com/download/
42194218
<Parameter Name="comparisonType" Type="System.StringComparison" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
42204219
</Parameters>
42214220
<Docs>
4222-
<param name="value">To be added.</param>
4223-
<param name="comparisonType">To be added.</param>
4224-
<summary>To be added.</summary>
4225-
<returns>To be added.</returns>
4221+
<param name="value">The string to seek.</param>
4222+
<param name="comparisonType">One of the enumeration values that specifies the rules to use in the comparison.</param>
4223+
<summary>Returns a value indicating whether a specified string occurs within this string, using the specified comparison rules.</summary>
4224+
<returns><see langword="true" /> if the <paramref name="value" /> parameter occurs within this string, or if <paramref name="value" /> is the empty string (""); otherwise, <see langword="false" />.</returns>
42264225
<remarks>To be added.</remarks>
42274226
</Docs>
42284227
</Member>
@@ -6318,9 +6317,9 @@ String 'This is a string.' in domain 'NewDomain': 75CC8236
63186317
<Parameter Name="value" Type="System.ReadOnlySpan&lt;System.Char&gt;" Index="0" FrameworkAlternate="netcore-3.0" />
63196318
</Parameters>
63206319
<Docs>
6321-
<param name="value">To be added.</param>
6322-
<summary>To be added.</summary>
6323-
<returns>To be added.</returns>
6320+
<param name="value">A read-only character span.</param>
6321+
<summary>Returns the hash code for the provided read-only character span.</summary>
6322+
<returns>A 32-bit signed integer hash code.</returns>
63246323
<remarks>To be added.</remarks>
63256324
</Docs>
63266325
</Member>
@@ -6351,9 +6350,9 @@ String 'This is a string.' in domain 'NewDomain': 75CC8236
63516350
<Parameter Name="comparisonType" Type="System.StringComparison" Index="0" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
63526351
</Parameters>
63536352
<Docs>
6354-
<param name="comparisonType">To be added.</param>
6355-
<summary>To be added.</summary>
6356-
<returns>To be added.</returns>
6353+
<param name="comparisonType">One of the enumeration values that specifies the rules to use in the comparison.</param>
6354+
<summary>Returns the hash code for this string using the specified rules.</summary>
6355+
<returns>A 32-bit signed integer hash code.</returns>
63576356
<remarks>To be added.</remarks>
63586357
</Docs>
63596358
</Member>
@@ -6383,10 +6382,10 @@ String 'This is a string.' in domain 'NewDomain': 75CC8236
63836382
<Parameter Name="comparisonType" Type="System.StringComparison" Index="1" FrameworkAlternate="netcore-3.0" />
63846383
</Parameters>
63856384
<Docs>
6386-
<param name="value">To be added.</param>
6387-
<param name="comparisonType">To be added.</param>
6388-
<summary>To be added.</summary>
6389-
<returns>To be added.</returns>
6385+
<param name="value">A read-only character span.</param>
6386+
<param name="comparisonType">One of the enumeration values that specifies the rules to use in the comparison.</param>
6387+
<summary>Returns the hash code for the provided read-only character span using the specified rules.</summary>
6388+
<returns>A 32-bit signed integer hash code.</returns>
63906389
<remarks>To be added.</remarks>
63916390
</Docs>
63926391
</Member>
@@ -6423,10 +6422,20 @@ String 'This is a string.' in domain 'NewDomain': 75CC8236
64236422
</ReturnValue>
64246423
<Parameters />
64256424
<Docs>
6426-
<summary>Returns a reference to the first element of the string.</summary>
6427-
<returns>A pinnable reference to the first element of the string as a read-only char.</returns>
6428-
<remarks>To be added.</remarks>
6429-
<exception cref="T:System.NullReferenceException">The string is <see langword="null" />.</exception>
6425+
<summary>Returns a reference to the element of the string at index zero.</summary>
6426+
<returns>A character representing the reference to the element of the string at index zero.</returns>
6427+
<remarks>
6428+
<format type="text/markdown">
6429+
<![CDATA[
6430+
6431+
## Remarks
6432+
6433+
The `GetPinnableReference` method returns a character that can be used for pinning a <xref:System.String> in memory. It is required to support the use of a <xref:System.String> within a fixed statement.
6434+
6435+
]]>
6436+
</format>
6437+
</remarks>
6438+
<exception cref="T:System.NullReferenceException">The string is null.</exception>
64306439
</Docs>
64316440
</Member>
64326441
<Member MemberName="GetTypeCode">

0 commit comments

Comments
 (0)