Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 9103e74

Browse files
authored
Document System.Convert (dotnet#3548)
* Document System.Convert * Suggestions by mairaw * Address false case
1 parent ff253d6 commit 9103e74

File tree

1 file changed

+31
-21
lines changed

1 file changed

+31
-21
lines changed

xml/System/Convert.xml

Lines changed: 31 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1208,7 +1208,7 @@
12081208
<param name="inArray">An array of 8-bit unsigned integers.</param>
12091209
<param name="options">
12101210
<see cref="F:System.Base64FormattingOptions.InsertLineBreaks" /> to insert a line break every 76 characters, or <see cref="F:System.Base64FormattingOptions.None" /> to not insert line breaks.</param>
1211-
<summary>Converts an array of 8-bit unsigned integers to its equivalent string representation that is encoded with base-64 digits. A parameter specifies whether to insert line breaks in the return value.</summary>
1211+
<summary>Converts an array of 8-bit unsigned integers to its equivalent string representation that is encoded with base-64 digits. You can specify whether to insert line breaks in the return value.</summary>
12121212
<returns>The string representation in base 64 of the elements in <paramref name="inArray" />.</returns>
12131213
<remarks>
12141214
<format type="text/markdown"><![CDATA[
@@ -1269,11 +1269,14 @@
12691269
<Parameter Name="options" Type="System.Base64FormattingOptions" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
12701270
</Parameters>
12711271
<Docs>
1272-
<param name="bytes">To be added.</param>
1273-
<param name="options">To be added.</param>
1274-
<summary>To be added.</summary>
1275-
<returns>To be added.</returns>
1272+
<param name="bytes">A read-only span of 8-bit unsigned integers.</param>
1273+
<param name="options">One of the enumeration values that specify whether to insert line breaks in the return value. The default value is <see cref="F:System.Base64FormattingOptions.None" />.</param>
1274+
<summary>Converts the 8-bit unsigned integers inside the specified read-only span into their equivalent string representation that is encoded with base-64 digits. You can optionally specify whether to insert line breaks in the return value.</summary>
1275+
<returns>The string representation in base 64 of the elements in <paramref name="inArray" />. If the length of <paramref name="bytes" /> is 0, an empty string is returned.</returns>
12761276
<remarks>To be added.</remarks>
1277+
<exception cref="T:System.ArgumentException">
1278+
<paramref name="options" /> is not a valid <see cref="T:System.Base64FormattingOptions" /> value.</exception>
1279+
<exception cref="T:System.OutOfMemoryException">The output length was larger than <see cref="P:System.Int32.MaxValue" />.</exception>
12771280
</Docs>
12781281
</Member>
12791282
<Member MemberName="ToBase64String">
@@ -18554,11 +18557,12 @@
1855418557
<Parameter Name="bytesWritten" Type="System.Int32" RefType="out" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
1855518558
</Parameters>
1855618559
<Docs>
18557-
<param name="chars">To be added.</param>
18558-
<param name="bytes">To be added.</param>
18559-
<param name="bytesWritten">To be added.</param>
18560-
<summary>To be added.</summary>
18561-
<returns>To be added.</returns>
18560+
<param name="chars">A span containing the string representation that is encoded with base-64 digits.</param>
18561+
<param name="bytes">When this method returns <see langword="true" />, the converted 8-bit unsigned integers. When this method returns <see langword="false" />, either the span remains unmodified or contains an incomplete conversion of <paramref name="chars" />, up to the last valid character.</param>
18562+
<param name="bytesWritten">When this method returns, the number of bytes that were written in <paramref name="bytes" />.</param>
18563+
<summary>Tries to convert the specified span containing a string representation that is encoded with base-64 digits into a span of 8-bit unsigned integers.</summary>
18564+
<returns>
18565+
<see langword="true" /> if the conversion was successful; otherwise, <see langword="false" />.</returns>
1856218566
<remarks>To be added.</remarks>
1856318567
</Docs>
1856418568
</Member>
@@ -18590,12 +18594,15 @@
1859018594
<Parameter Name="bytesWritten" Type="System.Int32" RefType="out" Index="2" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
1859118595
</Parameters>
1859218596
<Docs>
18593-
<param name="s">To be added.</param>
18594-
<param name="bytes">To be added.</param>
18595-
<param name="bytesWritten">To be added.</param>
18596-
<summary>To be added.</summary>
18597-
<returns>To be added.</returns>
18597+
<param name="s">The string representation that is encoded with base-64 digits.</param>
18598+
<param name="bytes">When this method returns <see langword="true" />, the converted 8-bit unsigned integers. When this method returns <see langword="false" />, either the span remains unmodified or contains an incomplete conversion of <paramref name="s" />, up to the last valid character.</param>
18599+
<param name="bytesWritten">When this method returns, the number of bytes that were written in <paramref name="bytes" />.</param>
18600+
<summary>Tries to convert the specified string representation that is encoded with base-64 digits into a span of 8-bit unsigned integers.</summary>
18601+
<returns>
18602+
<see langword="true" /> if the conversion was successful; otherwise, <see langword="false" />.</returns>
1859818603
<remarks>To be added.</remarks>
18604+
<exception cref="T:System.ArgumentNullException">
18605+
<paramref name="s" /> is <see langword="null" />.</exception>
1859918606
</Docs>
1860018607
</Member>
1860118608
<Member MemberName="TryToBase64Chars">
@@ -18626,13 +18633,16 @@
1862618633
<Parameter Name="options" Type="System.Base64FormattingOptions" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
1862718634
</Parameters>
1862818635
<Docs>
18629-
<param name="bytes">To be added.</param>
18630-
<param name="chars">To be added.</param>
18631-
<param name="charsWritten">To be added.</param>
18632-
<param name="options">To be added.</param>
18633-
<summary>To be added.</summary>
18634-
<returns>To be added.</returns>
18636+
<param name="bytes">A read-only span of 8-bit unsigned integers.</param>
18637+
<param name="chars">When this method returns <see langword="true" />, a span containing the string representation in base 64 of the elements in <paramref name="bytes" />. If the length of <paramref name="bytes" /> is 0, or when this method returns <paramref name="false" />, nothing is written into this parameter.</param>
18638+
<param name="charsWritten">When this method returns, the total number of characters written into <paramref name="chars" />.</param>
18639+
<param name="options">One of the enumeration values that specify whether to insert line breaks in the return value. The default value is <see cref="F:System.Base64FormattingOptions.None" />.</param>
18640+
<summary>Tries to convert the 8-bit unsigned integers inside the specified read-only span into their equivalent string representation that is encoded with base-64 digits. You can optionally specify whether to insert line breaks in the return value.</summary>
18641+
<returns>
18642+
<see langword="true" /> if the conversion is successful; otherwise, <see langword="false" />.</returns>
1863518643
<remarks>To be added.</remarks>
18644+
<exception cref="T:System.ArgumentException">
18645+
<paramref name="options" /> is not a valid <see cref="T:System.Base64FormattingOptions" /> value.</exception>
1863618646
</Docs>
1863718647
</Member>
1863818648
</Members>

0 commit comments

Comments
 (0)