Skip to content

Commit 7a80621

Browse files
authored
Document System.StringComparer (#3648)
* Document System.StringComparer.FromComparison * Document Create
1 parent dd7fe5d commit 7a80621

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

xml/System/StringComparer.xml

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -367,11 +367,15 @@ The following example demonstrates the properties and the <xref:System.StringCom
367367
<Parameter Name="options" Type="System.Globalization.CompareOptions" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
368368
</Parameters>
369369
<Docs>
370-
<param name="culture">To be added.</param>
371-
<param name="options">To be added.</param>
372-
<summary>To be added.</summary>
373-
<returns>To be added.</returns>
370+
<param name="culture">A culture whose linguistic rules are used to perform a string comparison.</param>
371+
<param name="options">A bitwise combination of the <see cref="T:System.Globalization.CompareOptions" /> values.</param>
372+
<summary>Creates a <see cref="T:System.StringComparer" /> object that compares strings according to the rules of a specified culture and string options.</summary>
373+
<returns>A new <see cref="T:System.StringComparer" /> object that performs string comparisons according to the comparison rules used by the <paramref name="culture" /> parameter and the specified <paramref name="options" />.</returns>
374374
<remarks>To be added.</remarks>
375+
<exception cref="T:System.ArgumentNullException">
376+
<paramref name="culture" /> is <see langword="null" />.</exception>
377+
<exception cref="T:System.ArgumentException">
378+
<paramref name="options" /> has invalid flags.</exception>
375379
</Docs>
376380
</Member>
377381
<Member MemberName="CurrentCulture">
@@ -637,10 +641,11 @@ The following example demonstrates the properties and the <xref:System.StringCom
637641
<Parameter Name="comparisonType" Type="System.StringComparison" Index="0" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
638642
</Parameters>
639643
<Docs>
640-
<param name="comparisonType">To be added.</param>
641-
<summary>To be added.</summary>
642-
<returns>To be added.</returns>
644+
<param name="comparisonType">A string comparer instance to convert.</param>
645+
<summary>Converts the specified <see cref="T:System.StringComparison" /> instance to a <see cref="T:System.StringComparer" /> instance.</summary>
646+
<returns>A <see cref="T:System.StringComparer" /> instance representing the equivalent value of the specified <see cref="T:System.StringComparison" /> instance.</returns>
643647
<remarks>To be added.</remarks>
648+
<exception cref="T:System.ArgumentException">The specified string comparison is not supported.</exception>
644649
</Docs>
645650
</Member>
646651
<MemberGroup MemberName="GetHashCode">

0 commit comments

Comments
 (0)