Skip to content

Commit cdd2c1f

Browse files
authored
Atomatically port Boolean comments (EII) (#4022)
* Atomatically port Boolean comments (EII) * Apply suggestions from code review
1 parent 14e94b9 commit cdd2c1f

File tree

1 file changed

+45
-11
lines changed

1 file changed

+45
-11
lines changed

xml/System/Boolean.xml

Lines changed: 45 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -800,10 +800,26 @@
800800
<Parameter Name="obj" Type="System.Object" Index="0" 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" />
801801
</Parameters>
802802
<Docs>
803-
<param name="obj">To be added.</param>
804-
<summary>To be added.</summary>
805-
<returns>To be added.</returns>
806-
<remarks>To be added.</remarks>
803+
<param name="obj">The object to compare.</param>
804+
<summary>Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.</summary>
805+
<returns>A value that indicates the relative order of the objects being compared.</returns>
806+
<remarks>
807+
<format type="text/markdown"><![CDATA[
808+
809+
## Remarks
810+
811+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Boolean> instance is cast to an <xref:System.IComparable> interface.
812+
813+
The return value has these meanings:
814+
815+
| Value | Meaning |
816+
|-------------------|-------------------------------------------------------------------------|
817+
| Less than zero | This instance precedes `obj` in the sort order. |
818+
| Zero | This instance occurs in the same position in the sort order as `obj`. |
819+
| Greater than zero | This instance follows `obj` in the sort order. |
820+
821+
]]></format>
822+
</remarks>
807823
</Docs>
808824
</Member>
809825
<Member MemberName="System.IConvertible.GetTypeCode">
@@ -833,9 +849,18 @@
833849
</ReturnValue>
834850
<Parameters />
835851
<Docs>
836-
<summary>To be added.</summary>
837-
<returns>To be added.</returns>
838-
<remarks>To be added.</remarks>
852+
<summary>Returns the <see cref="T:System.TypeCode" /> for this instance.</summary>
853+
<returns>The enumerated constant that is the <see cref="T:System.TypeCode" /> of the class or value type that implements this interface.</returns>
854+
<remarks>
855+
<format type="text/markdown"><![CDATA[
856+
857+
## Remarks
858+
859+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Boolean> instance is cast to an <xref:System.IConvertible> interface.
860+
861+
862+
]]></format>
863+
</remarks>
839864
</Docs>
840865
</Member>
841866
<Member MemberName="System.IConvertible.ToBoolean">
@@ -1434,10 +1459,19 @@
14341459
<Parameter Name="provider" Type="System.IFormatProvider" Index="0" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netstandard-1.3;netstandard-1.4;netstandard-1.5;netstandard-1.6" />
14351460
</Parameters>
14361461
<Docs>
1437-
<param name="provider">To be added.</param>
1438-
<summary>To be added.</summary>
1439-
<returns>To be added.</returns>
1440-
<remarks>To be added.</remarks>
1462+
<param name="provider">An object that supplies culture-specific formatting information.</param>
1463+
<summary>Converts the value of this instance to an equivalent string using the specified culture-specific formatting information.</summary>
1464+
<returns>A string instance equivalent to the value of this instance.</returns>
1465+
<remarks>
1466+
<format type="text/markdown"><![CDATA[
1467+
1468+
## Remarks
1469+
1470+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Boolean> instance is cast to an <xref:System.IConvertible> interface.
1471+
1472+
1473+
]]></format>
1474+
</remarks>
14411475
</Docs>
14421476
</Member>
14431477
<Member MemberName="System.IConvertible.ToType">

0 commit comments

Comments
 (0)