Skip to content

Commit 44250ea

Browse files
carlossanlopcarlossanlop
authored
Document EIIs of integer types (IComparable/IConvertible) (#3499)
1 parent 105b867 commit 44250ea

File tree

6 files changed

+300
-53
lines changed

6 files changed

+300
-53
lines changed

‎xml/System/Int16.xml

Lines changed: 50 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -248,8 +248,7 @@
248248
249249
]]></format>
250250
</remarks>
251-
<exception cref="T:System.ArgumentException">
252-
<paramref name="value" /> is not an <see cref="T:System.Int16" />.</exception>
251+
<exception cref="T:System.ArgumentException"><paramref name="value" /> is not an <see cref="T:System.Int16" />.</exception>
253252
<altmember cref="T:System.UInt16" />
254253
</Docs>
255254
</Member>
@@ -1065,10 +1064,44 @@
10651064
<Parameter Name="value" 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" />
10661065
</Parameters>
10671066
<Docs>
1068-
<param name="value">To be added.</param>
1069-
<summary>To be added.</summary>
1070-
<returns>To be added.</returns>
1071-
<remarks>To be added.</remarks>
1067+
<param name="value">An object to compare, or <see langword="null" />.</param>
1068+
<summary>Compares this instance to a specified object and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the object.</summary>
1069+
<returns>A signed number indicating the relative values of this instance and <paramref name="value" />.
1070+
<list type="table">
1071+
<listheader>
1072+
<term>Return Value</term>
1073+
<description>Description</description>
1074+
</listheader>
1075+
<item>
1076+
<term>Less than zero</term>
1077+
<description>This instance is less than <paramref name="value" />.</description>
1078+
</item>
1079+
<item>
1080+
<term>Zero</term>
1081+
<description>This instance is equal to <paramref name="value" />.</description>
1082+
</item>
1083+
<item>
1084+
<term>Greater than zero</term>
1085+
<description>This instance is greater than <paramref name="value" />.
1086+
1087+
-or-
1088+
1089+
<paramref name="value" /> is <see langword="null" />.</description>
1090+
</item>
1091+
</list>
1092+
</returns>
1093+
<remarks>
1094+
<format type="text/markdown"><![CDATA[
1095+
1096+
## Remarks
1097+
1098+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Int16> instance is cast to an <xref:System.IConvertible> interface.
1099+
1100+
An <xref:System.Int16>, regardless of its value, is considered greater than a null reference.
1101+
1102+
]]></format>
1103+
</remarks>
1104+
<exception cref="T:System.ArgumentException"><paramref name="value" /> is not an <see cref="T:System.Int16" />.</exception>
10721105
</Docs>
10731106
</Member>
10741107
<Member MemberName="System.IConvertible.GetTypeCode">
@@ -1097,9 +1130,17 @@
10971130
</ReturnValue>
10981131
<Parameters />
10991132
<Docs>
1100-
<summary>To be added.</summary>
1101-
<returns>To be added.</returns>
1102-
<remarks>To be added.</remarks>
1133+
<summary>Returns the <see cref="T:System.TypeCode" /> for value type <see cref="T:System.Int16" />.</summary>
1134+
<returns>The enumerated constant, <see cref="F:System.TypeCode.Int16" />.</returns>
1135+
<remarks>
1136+
<format type="text/markdown"><![CDATA[
1137+
1138+
## Remarks
1139+
1140+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Int16> instance is cast to an <xref:System.IConvertible> interface.
1141+
1142+
]]></format>
1143+
</remarks>
11031144
</Docs>
11041145
</Member>
11051146
<Member MemberName="System.IConvertible.ToBoolean">

‎xml/System/Int32.xml

Lines changed: 50 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -297,8 +297,7 @@
297297
298298
]]></format>
299299
</remarks>
300-
<exception cref="T:System.ArgumentException">
301-
<paramref name="value" /> is not an <see cref="T:System.Int32" />.</exception>
300+
<exception cref="T:System.ArgumentException"><paramref name="value" /> is not an <see cref="T:System.Int32" />.</exception>
302301
<altmember cref="T:System.UInt32" />
303302
<altmember cref="M:System.Int32.Equals(System.Object)" />
304303
</Docs>
@@ -1141,10 +1140,44 @@
11411140
<Parameter Name="value" 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" />
11421141
</Parameters>
11431142
<Docs>
1144-
<param name="value">To be added.</param>
1145-
<summary>To be added.</summary>
1146-
<returns>To be added.</returns>
1147-
<remarks>To be added.</remarks>
1143+
<param name="value">An object to compare, or <see langword="null" />.</param>
1144+
<summary>Compares this instance to a specified object and returns an indication of their relative values.</summary>
1145+
<returns>A signed number indicating the relative values of this instance and <paramref name="value" />.
1146+
<list type="table">
1147+
<listheader>
1148+
<term>Return Value</term>
1149+
<description>Description</description>
1150+
</listheader>
1151+
<item>
1152+
<term>Less than zero</term>
1153+
<description>This instance is less than <paramref name="value" />.</description>
1154+
</item>
1155+
<item>
1156+
<term>Zero</term>
1157+
<description>This instance is equal to <paramref name="value" />.</description>
1158+
</item>
1159+
<item>
1160+
<term>Greater than zero</term>
1161+
<description>This instance is greater than <paramref name="value" />.
1162+
1163+
-or-
1164+
1165+
<paramref name="value" /> is <see langword="null" />.</description>
1166+
</item>
1167+
</list>
1168+
</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.Int32> instance is cast to an <xref:System.IConvertible> interface.
1175+
1176+
Any instance of <xref:System.Int32>, regardless of its value, is considered greater than `null`.
1177+
1178+
]]></format>
1179+
</remarks>
1180+
<exception cref="T:System.ArgumentException"><paramref name="value" /> is not an <see cref="T:System.Int32" />.</exception>
11481181
</Docs>
11491182
</Member>
11501183
<Member MemberName="System.IConvertible.GetTypeCode">
@@ -1173,9 +1206,17 @@
11731206
</ReturnValue>
11741207
<Parameters />
11751208
<Docs>
1176-
<summary>To be added.</summary>
1177-
<returns>To be added.</returns>
1178-
<remarks>To be added.</remarks>
1209+
<summary>Returns the <see cref="T:System.TypeCode" /> for value type <see cref="T:System.Int32" />.</summary>
1210+
<returns>The enumerated constant, <see cref="F:System.TypeCode.Int32" />.</returns>
1211+
<remarks>
1212+
<format type="text/markdown"><![CDATA[
1213+
1214+
## Remarks
1215+
1216+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Int32> instance is cast to an <xref:System.IConvertible> interface.
1217+
1218+
]]></format>
1219+
</remarks>
11791220
</Docs>
11801221
</Member>
11811222
<Member MemberName="System.IConvertible.ToBoolean">

‎xml/System/Int64.xml

Lines changed: 50 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -293,8 +293,7 @@
293293
294294
]]></format>
295295
</remarks>
296-
<exception cref="T:System.ArgumentException">
297-
<paramref name="value" /> is not an <see cref="T:System.Int64" />.</exception>
296+
<exception cref="T:System.ArgumentException"><paramref name="value" /> is not an <see cref="T:System.Int64" />.</exception>
298297
<altmember cref="T:System.UInt64" />
299298
<altmember cref="M:System.Int64.Equals(System.Object)" />
300299
</Docs>
@@ -1089,9 +1088,44 @@
10891088
<Parameter Name="value" 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" />
10901089
</Parameters>
10911090
<Docs>
1092-
<param name="value">To be added.</param>
1093-
<summary>To be added.</summary>
1094-
<returns>To be added.</returns>
1091+
<param name="value">An object to compare, or <see langword="null" />.</param>
1092+
<summary>Compares this instance to a specified object and returns an indication of their relative values.</summary>
1093+
<returns>A signed number indicating the relative values of this instance and <paramref name="value" />.
1094+
<list type="table">
1095+
<listheader>
1096+
<term>Return Value</term>
1097+
<description>Description</description>
1098+
</listheader>
1099+
<item>
1100+
<term>Less than zero</term>
1101+
<description>This instance is less than <paramref name="value" />.</description>
1102+
</item>
1103+
<item>
1104+
<term>Zero</term>
1105+
<description>This instance is equal to <paramref name="value" />.</description>
1106+
</item>
1107+
<item>
1108+
<term>Greater than zero</term>
1109+
<description>This instance is greater than <paramref name="value" />.
1110+
1111+
-or-
1112+
1113+
<paramref name="value" /> is <see langword="null" />.</description>
1114+
</item>
1115+
</list>
1116+
</returns>
1117+
<remarks>
1118+
<format type="text/markdown"><![CDATA[
1119+
1120+
## Remarks
1121+
1122+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Int64> instance is cast to an <xref:System.IConvertible> interface.
1123+
1124+
An <xref:System.Int64>, regardless of its value, is considered greater than a null reference.
1125+
1126+
]]></format>
1127+
</remarks>
1128+
<exception cref="T:System.ArgumentException"><paramref name="value" /> is not an <see cref="T:System.Int64" />.</exception>
10951129
<remarks>To be added.</remarks>
10961130
</Docs>
10971131
</Member>
@@ -1121,9 +1155,17 @@
11211155
</ReturnValue>
11221156
<Parameters />
11231157
<Docs>
1124-
<summary>To be added.</summary>
1125-
<returns>To be added.</returns>
1126-
<remarks>To be added.</remarks>
1158+
<summary>Returns the <see cref="T:System.TypeCode" /> for value type <see cref="T:System.Int64" />.</summary>
1159+
<returns>The enumerated constant, <see cref="F:System.TypeCode.Int64" />.</returns>
1160+
<remarks>
1161+
<format type="text/markdown"><![CDATA[
1162+
1163+
## Remarks
1164+
1165+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Int64> instance is cast to an <xref:System.IConvertible> interface.
1166+
1167+
]]></format>
1168+
</remarks>
11271169
</Docs>
11281170
</Member>
11291171
<Member MemberName="System.IConvertible.ToBoolean">

‎xml/System/UInt16.xml

Lines changed: 50 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -172,8 +172,7 @@
172172
173173
]]></format>
174174
</remarks>
175-
<exception cref="T:System.ArgumentException">
176-
<paramref name="value" /> is not a <see cref="T:System.UInt16" />.</exception>
175+
<exception cref="T:System.ArgumentException"><paramref name="value" /> is not a <see cref="T:System.UInt16" />.</exception>
177176
<altmember cref="M:System.UInt16.Equals(System.Object)" />
178177
</Docs>
179178
</Member>
@@ -1122,10 +1121,44 @@
11221121
<Parameter Name="value" 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" />
11231122
</Parameters>
11241123
<Docs>
1125-
<param name="value">To be added.</param>
1126-
<summary>To be added.</summary>
1127-
<returns>To be added.</returns>
1128-
<remarks>To be added.</remarks>
1124+
<param name="value">An object to compare, or <see langword="null" />.</param>
1125+
<summary>Compares this instance to a specified object and returns an indication of their relative values.</summary>
1126+
<returns>A signed number indicating the relative values of this instance and <paramref name="value" />.
1127+
<list type="table">
1128+
<listheader>
1129+
<term>Return Value</term>
1130+
<description>Description</description>
1131+
</listheader>
1132+
<item>
1133+
<term>Less than zero</term>
1134+
<description>This instance is less than <paramref name="value" />.</description>
1135+
</item>
1136+
<item>
1137+
<term>Zero</term>
1138+
<description>This instance is equal to <paramref name="value" />.</description>
1139+
</item>
1140+
<item>
1141+
<term>Greater than zero</term>
1142+
<description>This instance is greater than <paramref name="value" />.
1143+
1144+
-or-
1145+
1146+
<paramref name="value" /> is <see langword="null" />.</description>
1147+
</item>
1148+
</list>
1149+
</returns>
1150+
<remarks>
1151+
<format type="text/markdown"><![CDATA[
1152+
1153+
## Remarks
1154+
1155+
This member is an explicit interface member implementation. It can be used only when the <xref:System.UInt16> instance is cast to an <xref:System.IConvertible> interface.
1156+
1157+
Any instance of <xref:System.UInt16>, regardless of its value, is considered greater than `null`.
1158+
1159+
]]></format>
1160+
</remarks>
1161+
<exception cref="T:System.ArgumentException"><paramref name="value" /> is not a <see cref="T:System.UInt16" />.</exception>
11291162
</Docs>
11301163
</Member>
11311164
<Member MemberName="System.IConvertible.GetTypeCode">
@@ -1154,9 +1187,17 @@
11541187
</ReturnValue>
11551188
<Parameters />
11561189
<Docs>
1157-
<summary>To be added.</summary>
1158-
<returns>To be added.</returns>
1159-
<remarks>To be added.</remarks>
1190+
<summary>Returns the <see cref="T:System.TypeCode" /> for value type <see cref="T:System.UInt16" />.</summary>
1191+
<returns>The enumerated constant, <see cref="F:System.TypeCode.UInt16" />.</returns>
1192+
<remarks>
1193+
<format type="text/markdown"><![CDATA[
1194+
1195+
## Remarks
1196+
1197+
This member is an explicit interface member implementation. It can be used only when the <xref:System.UInt16> instance is cast to an <xref:System.IConvertible> interface.
1198+
1199+
]]></format>
1200+
</remarks>
11601201
</Docs>
11611202
</Member>
11621203
<Member MemberName="System.IConvertible.ToBoolean">

‎xml/System/UInt32.xml

Lines changed: 50 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -172,8 +172,7 @@
172172
173173
]]></format>
174174
</remarks>
175-
<exception cref="T:System.ArgumentException">
176-
<paramref name="value" /> is not a <see cref="T:System.UInt32" />.</exception>
175+
<exception cref="T:System.ArgumentException"><paramref name="value" /> is not a <see cref="T:System.UInt32" />.</exception>
177176
<altmember cref="M:System.UInt32.Equals(System.Object)" />
178177
</Docs>
179178
</Member>
@@ -1135,10 +1134,44 @@
11351134
<Parameter Name="value" 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" />
11361135
</Parameters>
11371136
<Docs>
1138-
<param name="value">To be added.</param>
1139-
<summary>To be added.</summary>
1140-
<returns>To be added.</returns>
1141-
<remarks>To be added.</remarks>
1137+
<param name="value">An object to compare, or <see langword="null" />.</param>
1138+
<summary>Compares this instance to a specified object and returns an indication of their relative values.</summary>
1139+
<returns>A signed number indicating the relative values of this instance and <paramref name="value" />.
1140+
<list type="table">
1141+
<listheader>
1142+
<term>Return Value</term>
1143+
<description>Description</description>
1144+
</listheader>
1145+
<item>
1146+
<term>Less than zero</term>
1147+
<description>This instance is less than <paramref name="value" />.</description>
1148+
</item>
1149+
<item>
1150+
<term>Zero</term>
1151+
<description>This instance is equal to <paramref name="value" />.</description>
1152+
</item>
1153+
<item>
1154+
<term>Greater than zero</term>
1155+
<description>This instance is greater than <paramref name="value" />.
1156+
1157+
-or-
1158+
1159+
<paramref name="value" /> is <see langword="null" />.</description>
1160+
</item>
1161+
</list>
1162+
</returns>
1163+
<remarks>
1164+
<format type="text/markdown"><![CDATA[
1165+
1166+
## Remarks
1167+
1168+
This member is an explicit interface member implementation. It can be used only when the <xref:System.UInt32> instance is cast to an <xref:System.IConvertible> interface.
1169+
1170+
Any instance of <xref:System.UInt32>, regardless of its value, is considered greater than `null`.
1171+
1172+
]]></format>
1173+
</remarks>
1174+
<exception cref="T:System.ArgumentException"><paramref name="value" /> is not a <see cref="T:System.UInt32" />.</exception>
11421175
</Docs>
11431176
</Member>
11441177
<Member MemberName="System.IConvertible.GetTypeCode">
@@ -1167,9 +1200,17 @@
11671200
</ReturnValue>
11681201
<Parameters />
11691202
<Docs>
1170-
<summary>To be added.</summary>
1171-
<returns>To be added.</returns>
1172-
<remarks>To be added.</remarks>
1203+
<summary>Returns the <see cref="T:System.TypeCode" /> for value type <see cref="T:System.UInt32" />.</summary>
1204+
<returns>The enumerated constant, <see cref="F:System.TypeCode.UInt32" />.</returns>
1205+
<remarks>
1206+
<format type="text/markdown"><![CDATA[
1207+
1208+
## Remarks
1209+
1210+
This member is an explicit interface member implementation. It can be used only when the <xref:System.UInt32> instance is cast to an <xref:System.IConvertible> interface.
1211+
1212+
]]></format>
1213+
</remarks>
11731214
</Docs>
11741215
</Member>
11751216
<Member MemberName="System.IConvertible.ToBoolean">

0 commit comments

Comments
 (0)