Skip to content

Commit febdd37

Browse files
carlossanlopmairaw
andauthored
Document System.Enum (#3626)
* Document System.Enum * suggestions by mairaw Co-Authored-By: Maira Wenzel <[email protected]>
1 parent 7bc1fd9 commit febdd37

File tree

1 file changed

+29
-15
lines changed

1 file changed

+29
-15
lines changed

xml/System/Enum.xml

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1314,11 +1314,17 @@ thisInstance And flag = flag
13141314
<Parameter Name="value" Type="System.String" Index="0" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
13151315
</Parameters>
13161316
<Docs>
1317-
<typeparam name="TEnum">To be added.</typeparam>
1318-
<param name="value">To be added.</param>
1319-
<summary>To be added.</summary>
1320-
<returns>To be added.</returns>
1317+
<typeparam name="TEnum">An enumeration type.</typeparam>
1318+
<param name="value">A string containing the name or value to convert.</param>
1319+
<summary>Converts the string representation of the name or numeric value of one or more enumerated constants specified by <typeparamref name="TEnum" /> to an equivalent enumerated object.</summary>
1320+
<returns>An object of type <paramref name="TEnum" /> whose value is represented by <paramref name="value" />.</returns>
13211321
<remarks>To be added.</remarks>
1322+
<exception cref="T:System.ArgumentException">
1323+
<typeparamref name="TEnum" /> is not an <see cref="T:System.Enum" /> type.</exception>
1324+
<exception cref="T:System.ArgumentNullException">
1325+
<paramref name="value" /> is <see langword="null" />.</exception>
1326+
<exception cref="T:System.ArgumentException">
1327+
<paramref name="value" /> does not contain enumeration information.</exception>
13221328
</Docs>
13231329
</Member>
13241330
<Member MemberName="Parse&lt;TEnum&gt;">
@@ -1358,12 +1364,19 @@ thisInstance And flag = flag
13581364
<Parameter Name="ignoreCase" Type="System.Boolean" Index="1" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
13591365
</Parameters>
13601366
<Docs>
1361-
<typeparam name="TEnum">To be added.</typeparam>
1362-
<param name="value">To be added.</param>
1363-
<param name="ignoreCase">To be added.</param>
1364-
<summary>To be added.</summary>
1365-
<returns>To be added.</returns>
1367+
<typeparam name="TEnum">An enumeration type.</typeparam>
1368+
<param name="value">A string containing the name or value to convert.</param>
1369+
<param name="ignoreCase">
1370+
<see langword="true" /> to ignore case; <see langword="false" /> to regard case.</param>
1371+
<summary>Converts the string representation of the name or numeric value of one or more enumerated constants specified by <typeparamref name="TEnum" /> to an equivalent enumerated object. A parameter specifies whether the operation is case-insensitive.</summary>
1372+
<returns>An object of type <paramref name="TEnum" /> whose value is represented by <paramref name="value" />.</returns>
13661373
<remarks>To be added.</remarks>
1374+
<exception cref="T:System.ArgumentException">
1375+
<typeparamref name="TEnum" /> is not an <see cref="T:System.Enum" /> type.</exception>
1376+
<exception cref="T:System.ArgumentNullException">
1377+
<paramref name="value" /> is <see langword="null" />.</exception>
1378+
<exception cref="T:System.ArgumentException">
1379+
<paramref name="value" /> does not contain enumeration information.</exception>
13671380
</Docs>
13681381
</Member>
13691382
<Member MemberName="System.IConvertible.GetTypeCode">
@@ -1393,9 +1406,10 @@ thisInstance And flag = flag
13931406
</ReturnValue>
13941407
<Parameters />
13951408
<Docs>
1396-
<summary>To be added.</summary>
1397-
<returns>To be added.</returns>
1409+
<summary>Returns the type code of this <see cref="T:System.Enum" /> instance.</summary>
1410+
<returns>An enumeration value that describes the type code of this <see cref="T:System.Enum" /> instance.</returns>
13981411
<remarks>To be added.</remarks>
1412+
<exception cref="T:System.InvalidOperationException">The enum type is unknown.</exception>
13991413
</Docs>
14001414
</Member>
14011415
<Member MemberName="System.IConvertible.ToBoolean">
@@ -1981,9 +1995,9 @@ thisInstance And flag = flag
19811995
<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" />
19821996
</Parameters>
19831997
<Docs>
1984-
<param name="provider">To be added.</param>
1985-
<summary>To be added.</summary>
1986-
<returns>To be added.</returns>
1998+
<param name="provider">An <see cref="T:System.IFormatProvider" /> implementation that supplies culture-specific information about the format of the returned value. This argument is not used.</param>
1999+
<summary>This method overload is obsolete; use <see cref="M:System.Enum.ToString" /> instead.</summary>
2000+
<returns>The string representation of the value of this instance.</returns>
19872001
<remarks>To be added.</remarks>
19882002
</Docs>
19892003
</Member>
@@ -2236,7 +2250,7 @@ thisInstance And flag = flag
22362250
</Parameters>
22372251
<Docs>
22382252
<param name="format">A format specification.</param>
2239-
<param name="provider">To be added.</param>
2253+
<param name="provider">An <see cref="T:System.IFormatProvider" /> implementation that supplies culture-specific information about the format of the returned value. This argument is not used.</param>
22402254
<summary>This method overload is obsolete; use <see cref="M:System.Enum.ToString(System.String)" />.</summary>
22412255
<returns>The string representation of the value of this instance, as specified by <paramref name="format" />.</returns>
22422256
<remarks>To be added.</remarks>

0 commit comments

Comments
 (0)