Skip to content

Commit a2982c8

Browse files
authored
Automatically port StringComparer docs (EII) (#4027)
1 parent 9d868d3 commit a2982c8

File tree

1 file changed

+47
-14
lines changed

1 file changed

+47
-14
lines changed

xml/System/StringComparer.xml

Lines changed: 47 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1101,11 +1101,27 @@ The following example demonstrates the properties and the <xref:System.StringCom
11011101
<Parameter Name="y" Type="System.Object" Index="1" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netstandard-1.0;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.5;netstandard-1.6" />
11021102
</Parameters>
11031103
<Docs>
1104-
<param name="x">To be added.</param>
1105-
<param name="y">To be added.</param>
1106-
<summary>To be added.</summary>
1107-
<returns>To be added.</returns>
1108-
<remarks>To be added.</remarks>
1104+
<param name="x">The first object to compare.</param>
1105+
<param name="y">The second object to compare.</param>
1106+
<summary>Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other.</summary>
1107+
<returns>A signed integer that indicates the relative values of <paramref name="x" /> and <paramref name="y" />.</returns>
1108+
<remarks>
1109+
<format type="text/markdown"><![CDATA[
1110+
1111+
## Remarks
1112+
1113+
This member is an explicit interface member implementation. It can be used only when the <xref:System.StringComparer> instance is cast to an <xref:System.Collections.IComparer> interface.
1114+
1115+
The return value has these meanings:
1116+
1117+
| Value | Meaning |
1118+
|-------------------|--------------------------|
1119+
| Less than zero | `x` is less than `y`. |
1120+
| Zero | `x` equals `y`. |
1121+
| Greater than zero | `x` is greater than `y`. |
1122+
1123+
]]></format>
1124+
</remarks>
11091125
</Docs>
11101126
</Member>
11111127
<Member MemberName="System.Collections.IEqualityComparer.Equals">
@@ -1145,11 +1161,20 @@ The following example demonstrates the properties and the <xref:System.StringCom
11451161
<Parameter Name="y" Type="System.Object" Index="1" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netstandard-1.0;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.5;netstandard-1.6;netstandard-2.1" />
11461162
</Parameters>
11471163
<Docs>
1148-
<param name="x">To be added.</param>
1149-
<param name="y">To be added.</param>
1150-
<summary>To be added.</summary>
1151-
<returns>To be added.</returns>
1152-
<remarks>To be added.</remarks>
1164+
<param name="x">The first object to compare.</param>
1165+
<param name="y">The second object to compare.</param>
1166+
<summary>Determines whether the specified objects are equal.</summary>
1167+
<returns>
1168+
<see langword="true" /> if the specified objects are equal; otherwise, <see langword="false" />.</returns>
1169+
<remarks>
1170+
<format type="text/markdown"><![CDATA[
1171+
1172+
## Remarks
1173+
1174+
This member is an explicit interface member implementation. It can be used only when the <xref:System.StringComparer> instance is cast to an <xref:System.Collections.IEqualityComparer> interface.
1175+
1176+
]]></format>
1177+
</remarks>
11531178
</Docs>
11541179
</Member>
11551180
<Member MemberName="System.Collections.IEqualityComparer.GetHashCode">
@@ -1188,10 +1213,18 @@ The following example demonstrates the properties and the <xref:System.StringCom
11881213
<Parameter Name="obj" Type="System.Object" Index="0" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netstandard-1.0;netstandard-1.1;netstandard-1.2;netstandard-1.3;netstandard-1.4;netstandard-1.5;netstandard-1.6;netstandard-2.1" />
11891214
</Parameters>
11901215
<Docs>
1191-
<param name="obj">To be added.</param>
1192-
<summary>To be added.</summary>
1193-
<returns>To be added.</returns>
1194-
<remarks>To be added.</remarks>
1216+
<param name="obj">The object from which to obtain the hash code.</param>
1217+
<summary>Returns a hash code for the specified object.</summary>
1218+
<returns>A hash code for the specified object.</returns>
1219+
<remarks>
1220+
<format type="text/markdown"><![CDATA[
1221+
1222+
## Remarks
1223+
1224+
This member is an explicit interface member implementation. It can be used only when the <xref:System.StringComparer> instance is cast to an <xref:System.Collections.IEqualityComparer> interface.
1225+
1226+
]]></format>
1227+
</remarks>
11951228
</Docs>
11961229
</Member>
11971230
</Members>

0 commit comments

Comments
 (0)