Skip to content

Commit bd2dca8

Browse files
carlossanlopRon Petrusha
carlossanlop
authored and
Ron Petrusha
committed
Document System.BitConverter (#3250)
* Document System.BitConverter * suggestions by jkotas and rpetrusha Co-Authored-By: Jan Kotas <[email protected]> Co-Authored-By: Ron Petrusha <[email protected]> * Update BitConverter.xml * fix build issue * feedback
1 parent aedd6a1 commit bd2dca8

File tree

1 file changed

+89
-79
lines changed

1 file changed

+89
-79
lines changed

‎xml/System/BitConverter.xml

Lines changed: 89 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -809,9 +809,9 @@
809809
<Parameter Name="value" Type="System.Int32" Index="0" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
810810
</Parameters>
811811
<Docs>
812-
<param name="value">To be added.</param>
813-
<summary>To be added.</summary>
814-
<returns>To be added.</returns>
812+
<param name="value">The integer to convert.</param>
813+
<summary>Reinterprets the specified 32-bit integer as a single-precision floating-point value.</summary>
814+
<returns>A single-precision floating-point value that represents the converted integer.</returns>
815815
<remarks>To be added.</remarks>
816816
</Docs>
817817
</Member>
@@ -856,7 +856,7 @@
856856
</Parameters>
857857
<Docs>
858858
<param name="value">The number to convert.</param>
859-
<summary>Converts the specified 64-bit signed integer to a double-precision floating point number.</summary>
859+
<summary>Reinterprets the specified 64-bit signed integer to a double-precision floating point number.</summary>
860860
<returns>A double-precision floating point number whose value is equivalent to <paramref name="value" />.</returns>
861861
<remarks>
862862
<format type="text/markdown"><![CDATA[
@@ -960,9 +960,9 @@
960960
<Parameter Name="value" Type="System.Single" Index="0" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
961961
</Parameters>
962962
<Docs>
963-
<param name="value">To be added.</param>
964-
<summary>To be added.</summary>
965-
<returns>To be added.</returns>
963+
<param name="value">The single-precision floating-point value to convert.</param>
964+
<summary>Converts a single-precision floating-point value into an integer.</summary>
965+
<returns>An integer representing the converted single-precision floating-point value.</returns>
966966
<remarks>To be added.</remarks>
967967
</Docs>
968968
</Member>
@@ -992,10 +992,12 @@
992992
<Parameter Name="value" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="0" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
993993
</Parameters>
994994
<Docs>
995-
<param name="value">To be added.</param>
996-
<summary>To be added.</summary>
997-
<returns>To be added.</returns>
995+
<param name="value">A read-only span containing the bytes to convert.</param>
996+
<summary>Converts a read-only byte span to a Boolean value.</summary>
997+
<returns>A Boolean representing the converted bytes.</returns>
998998
<remarks>To be added.</remarks>
999+
<exception cref="T:System.ArgumentOutOfRangeException">The length of <paramref name="value" /> is less than 0.</exception>
1000+
9991001
</Docs>
10001002
</Member>
10011003
<Member MemberName="ToBoolean">
@@ -1089,10 +1091,11 @@
10891091
<Parameter Name="value" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="0" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
10901092
</Parameters>
10911093
<Docs>
1092-
<param name="value">To be added.</param>
1093-
<summary>To be added.</summary>
1094-
<returns>To be added.</returns>
1095-
<remarks>To be added.</remarks>
1094+
<param name="value">A read-only span containing the bytes to convert.</param>
1095+
<summary>Converts a read-only byte span into a character.</summary>
1096+
<returns>A character representing the converted bytes.</returns>
1097+
<remarks>To be added.</remarks>
1098+
<exception cref="T:System.ArgumentOutOfRangeException">The length of <paramref name="value" /> is less than the length of a <see cref="T:System.Char" />.</exception>
10961099
</Docs>
10971100
</Member>
10981101
<Member MemberName="ToChar">
@@ -1187,10 +1190,11 @@
11871190
<Parameter Name="value" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="0" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
11881191
</Parameters>
11891192
<Docs>
1190-
<param name="value">To be added.</param>
1191-
<summary>To be added.</summary>
1192-
<returns>To be added.</returns>
1193-
<remarks>To be added.</remarks>
1193+
<param name="value">A read-only span containing the bytes to convert.</param>
1194+
<summary>Converts a read-only byte span into a double-precision floating-point value.</summary>
1195+
<returns>A double-precision floating-point value that represents the converted bytes.</returns>
1196+
<remarks>To be added.</remarks>
1197+
<exception cref="T:System.ArgumentOutOfRangeException">The length of <paramref name="value" /> is less than the length of a <see cref="T:System.Double" /> value.</exception>
11941198
</Docs>
11951199
</Member>
11961200
<Member MemberName="ToDouble">
@@ -1290,10 +1294,11 @@
12901294
<Parameter Name="value" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="0" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
12911295
</Parameters>
12921296
<Docs>
1293-
<param name="value">To be added.</param>
1294-
<summary>To be added.</summary>
1295-
<returns>To be added.</returns>
1297+
<param name="value">A read-only span containing the bytes to convert.</param>
1298+
<summary>Converts a read-only byte span into a 16-bit signed integer.</summary>
1299+
<returns>A 16-bit signed integer representing the converted bytes.</returns>
12961300
<remarks>To be added.</remarks>
1301+
<exception cref="T:System.ArgumentOutOfRangeException">The length of <paramref name="value" /> is less than 2.</exception>
12971302
</Docs>
12981303
</Member>
12991304
<Member MemberName="ToInt16">
@@ -1393,10 +1398,11 @@
13931398
<Parameter Name="value" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="0" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
13941399
</Parameters>
13951400
<Docs>
1396-
<param name="value">To be added.</param>
1397-
<summary>To be added.</summary>
1398-
<returns>To be added.</returns>
1401+
<param name="value">A read-only span containing the bytes to convert.</param>
1402+
<summary>Converts a read-only byte span into a 32-bit signed integer.</summary>
1403+
<returns>A 32-bit signed integer representing the converted bytes.</returns>
13991404
<remarks>To be added.</remarks>
1405+
<exception cref="T:System.ArgumentOutOfRangeException">The length of <paramref name="value" /> is less than 4.</exception>
14001406
</Docs>
14011407
</Member>
14021408
<Member MemberName="ToInt32">
@@ -1495,10 +1501,11 @@
14951501
<Parameter Name="value" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="0" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
14961502
</Parameters>
14971503
<Docs>
1498-
<param name="value">To be added.</param>
1499-
<summary>To be added.</summary>
1500-
<returns>To be added.</returns>
1504+
<param name="value">A read-only span containing the bytes to convert.</param>
1505+
<summary>Converts a read-only byte span into a 64-bit signed integer.</summary>
1506+
<returns>A 64-bit signed integer representing the converted bytes.</returns>
15011507
<remarks>To be added.</remarks>
1508+
<exception cref="T:System.ArgumentOutOfRangeException">The length of <paramref name="value" /> is less than 8.</exception>
15021509
</Docs>
15031510
</Member>
15041511
<Member MemberName="ToInt64">
@@ -1598,10 +1605,11 @@
15981605
<Parameter Name="value" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="0" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
15991606
</Parameters>
16001607
<Docs>
1601-
<param name="value">To be added.</param>
1602-
<summary>To be added.</summary>
1603-
<returns>To be added.</returns>
1608+
<param name="value">A read-only span containing the bytes to convert.</param>
1609+
<summary>Converts a read-only byte span into a double-precision floating-point value.</summary>
1610+
<returns>A double-precision floating-point value representing the converted bytes.</returns>
16041611
<remarks>To be added.</remarks>
1612+
<exception cref="T:System.ArgumentOutOfRangeException">The length of <paramref name="value" /> is less than the length of a <see cref="T:System.Double" /> value.</exception>
16051613
</Docs>
16061614
</Member>
16071615
<Member MemberName="ToSingle">
@@ -1912,10 +1920,11 @@
19121920
<Parameter Name="value" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="0" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
19131921
</Parameters>
19141922
<Docs>
1915-
<param name="value">To be added.</param>
1916-
<summary>To be added.</summary>
1917-
<returns>To be added.</returns>
1923+
<param name="value">A read-only span containing the bytes to convert.</param>
1924+
<summary>Converts a read-only byte-span into a 16-bit unsigned integer.</summary>
1925+
<returns>An 16-bit unsigned integer representing the converted bytes.</returns>
19181926
<remarks>To be added.</remarks>
1927+
<exception cref="T:System.ArgumentOutOfRangeException">The length of <paramref name="value" /> is less than the 2.</exception>
19191928
</Docs>
19201929
</Member>
19211930
<Member MemberName="ToUInt16">
@@ -2020,10 +2029,11 @@
20202029
<Parameter Name="value" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="0" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
20212030
</Parameters>
20222031
<Docs>
2023-
<param name="value">To be added.</param>
2024-
<summary>To be added.</summary>
2025-
<returns>To be added.</returns>
2032+
<param name="value">A read-only span containing the bytes to convert.</param>
2033+
<summary>Converts a read-only byte span into a 32-bit unsigned integer.</summary>
2034+
<returns>A 32-bit unsigned integer representing the converted bytes.</returns>
20262035
<remarks>To be added.</remarks>
2036+
<exception cref="T:System.ArgumentOutOfRangeException">The length of <paramref name="value" /> is less than 4.</exception>
20272037
</Docs>
20282038
</Member>
20292039
<Member MemberName="ToUInt32">
@@ -2128,9 +2138,9 @@
21282138
<Parameter Name="value" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="0" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
21292139
</Parameters>
21302140
<Docs>
2131-
<param name="value">To be added.</param>
2132-
<summary>To be added.</summary>
2133-
<returns>To be added.</returns>
2141+
<param name="value">A read-only span containing the bytes to convert.</param>
2142+
<summary>Converts bytes into an unsigned long.</summary>
2143+
<returns>A 64-bit unsigned integer representing the converted bytes.</returns>
21342144
<remarks>To be added.</remarks>
21352145
</Docs>
21362146
</Member>
@@ -2232,10 +2242,10 @@
22322242
<Parameter Name="value" Type="System.Boolean" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
22332243
</Parameters>
22342244
<Docs>
2235-
<param name="destination">To be added.</param>
2236-
<param name="value">To be added.</param>
2237-
<summary>To be added.</summary>
2238-
<returns>To be added.</returns>
2245+
<param name="destination">When this method returns, the bytes representing the converted Boolean.</param>
2246+
<param name="value">The Boolean to convert.</param>
2247+
<summary>Converts a Boolean into a span of bytes.</summary>
2248+
<returns><see langword="true" /> if the conversion was successful; <see langword="false" /> otherwise.</returns>
22392249
<remarks>To be added.</remarks>
22402250
</Docs>
22412251
</Member>
@@ -2266,10 +2276,10 @@
22662276
<Parameter Name="value" Type="System.Char" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
22672277
</Parameters>
22682278
<Docs>
2269-
<param name="destination">To be added.</param>
2270-
<param name="value">To be added.</param>
2271-
<summary>To be added.</summary>
2272-
<returns>To be added.</returns>
2279+
<param name="destination">When this method returns, the bytes representing the converted character.</param>
2280+
<param name="value">The character to convert.</param>
2281+
<summary>Converts a character into a span of bytes.</summary>
2282+
<returns><see langword="true" /> if the conversion was successful; <see langword="false" /> otherwise.</returns>
22732283
<remarks>To be added.</remarks>
22742284
</Docs>
22752285
</Member>
@@ -2300,10 +2310,10 @@
23002310
<Parameter Name="value" Type="System.Double" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
23012311
</Parameters>
23022312
<Docs>
2303-
<param name="destination">To be added.</param>
2304-
<param name="value">To be added.</param>
2305-
<summary>To be added.</summary>
2306-
<returns>To be added.</returns>
2313+
<param name="destination">When this method returns, the bytes representing the converted double-precision floating-point value.</param>
2314+
<param name="value">The double-precision floating-point value to convert.</param>
2315+
<summary>Converts a double-precision floating-point value into a span of bytes.</summary>
2316+
<returns><see langword="true" /> if the conversion was successful; <see langword="false" /> otherwise.</returns>
23072317
<remarks>To be added.</remarks>
23082318
</Docs>
23092319
</Member>
@@ -2334,10 +2344,10 @@
23342344
<Parameter Name="value" Type="System.Int16" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
23352345
</Parameters>
23362346
<Docs>
2337-
<param name="destination">To be added.</param>
2338-
<param name="value">To be added.</param>
2339-
<summary>To be added.</summary>
2340-
<returns>To be added.</returns>
2347+
<param name="destination">When this method returns, the bytes representing the converted 16-bit signed integer.</param>
2348+
<param name="value">The 16-bit signed integer to convert.</param>
2349+
<summary>Converts a 16-bit signed integer into a span of bytes.</summary>
2350+
<returns><see langword="true" /> if the conversion was successful; <see langword="false" /> otherwise.</returns>
23412351
<remarks>To be added.</remarks>
23422352
</Docs>
23432353
</Member>
@@ -2368,10 +2378,10 @@
23682378
<Parameter Name="value" Type="System.Int32" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
23692379
</Parameters>
23702380
<Docs>
2371-
<param name="destination">To be added.</param>
2372-
<param name="value">To be added.</param>
2373-
<summary>To be added.</summary>
2374-
<returns>To be added.</returns>
2381+
<param name="destination">When this method returns, the bytes representing the converted 32-bit signed integer.</param>
2382+
<param name="value">The 32-bit signed integer to convert.</param>
2383+
<summary>Converts a 32-bit signed integer into a span of bytes.</summary>
2384+
<returns><see langword="true" /> if the conversion was successful; <see langword="false" /> otherwise.</returns>
23752385
<remarks>To be added.</remarks>
23762386
</Docs>
23772387
</Member>
@@ -2402,10 +2412,10 @@
24022412
<Parameter Name="value" Type="System.Int64" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
24032413
</Parameters>
24042414
<Docs>
2405-
<param name="destination">To be added.</param>
2406-
<param name="value">To be added.</param>
2407-
<summary>To be added.</summary>
2408-
<returns>To be added.</returns>
2415+
<param name="destination">When this method returns, the bytes representing the converted 64-bit signed integer.</param>
2416+
<param name="value">The 64-bit signed integer to convert.</param>
2417+
<summary>Converts a 64-bit signed integer into a span of bytes.</summary>
2418+
<returns><see langword="true" /> if the conversion was successful; <see langword="false" /> otherwise.</returns>
24092419
<remarks>To be added.</remarks>
24102420
</Docs>
24112421
</Member>
@@ -2436,10 +2446,10 @@
24362446
<Parameter Name="value" Type="System.Single" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
24372447
</Parameters>
24382448
<Docs>
2439-
<param name="destination">To be added.</param>
2440-
<param name="value">To be added.</param>
2441-
<summary>To be added.</summary>
2442-
<returns>To be added.</returns>
2449+
<param name="destination">When this method returns, the bytes representing the converted double-precision floating-point value.</param>
2450+
<param name="value">The double-precision floating-point value to convert.</param>
2451+
<summary>Converts a double-precision floating-point value into a span of bytes.</summary>
2452+
<returns><see langword="true" /> if the conversion was successful; <see langword="false" /> otherwise.</returns>
24432453
<remarks>To be added.</remarks>
24442454
</Docs>
24452455
</Member>
@@ -2475,10 +2485,10 @@
24752485
<Parameter Name="value" Type="System.UInt16" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
24762486
</Parameters>
24772487
<Docs>
2478-
<param name="destination">To be added.</param>
2479-
<param name="value">To be added.</param>
2480-
<summary>To be added.</summary>
2481-
<returns>To be added.</returns>
2488+
<param name="destination">When this method returns, the bytes representing the converted unsigned 16-bit integer.</param>
2489+
<param name="value">The unsigned 16-bit integer to convert.</param>
2490+
<summary>Converts an unsigned 16-bit integer into a span of bytes.</summary>
2491+
<returns><see langword="true" /> if the conversion was successful; <see langword="false" /> otherwise.</returns>
24822492
<remarks>To be added.</remarks>
24832493
</Docs>
24842494
</Member>
@@ -2514,10 +2524,10 @@
25142524
<Parameter Name="value" Type="System.UInt32" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
25152525
</Parameters>
25162526
<Docs>
2517-
<param name="destination">To be added.</param>
2518-
<param name="value">To be added.</param>
2519-
<summary>To be added.</summary>
2520-
<returns>To be added.</returns>
2527+
<param name="destination">When this method returns, the bytes representing the converted unsigned 32-bit integer.</param>
2528+
<param name="value">The unsigned 32-bit integer to convert.</param>
2529+
<summary>Converts a 32-bit unsigned integer into a span of bytes.</summary>
2530+
<returns><see langword="true" /> if the conversion was successful; <see langword="false" /> otherwise.</returns>
25212531
<remarks>To be added.</remarks>
25222532
</Docs>
25232533
</Member>
@@ -2553,10 +2563,10 @@
25532563
<Parameter Name="value" Type="System.UInt64" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
25542564
</Parameters>
25552565
<Docs>
2556-
<param name="destination">To be added.</param>
2557-
<param name="value">To be added.</param>
2558-
<summary>To be added.</summary>
2559-
<returns>To be added.</returns>
2566+
<param name="destination">When this method returns, the bytes representing the converted unsigned 64-bit integer.</param>
2567+
<param name="value">The unsigned 64-bit integer to convert.</param>
2568+
<summary>Converts an unsigned 64-bit integer into a span of bytes.</summary>
2569+
<returns><see langword="true" /> if the conversion was successful; <see langword="false" /> otherwise.</returns>
25602570
<remarks>To be added.</remarks>
25612571
</Docs>
25622572
</Member>

0 commit comments

Comments
 (0)