Skip to content

Commit 4dcdbb0

Browse files
committed
Clarify return values of Base64Url.Try* methods
1 parent 573b097 commit 4dcdbb0

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

xml/System.Buffers.Text/Base64Url.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -705,7 +705,7 @@
705705
<param name="bytesWritten">When this method returns, contains the number of bytes written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized.</param>
706706
<summary>Decodes the span of unicode ASCII chars represented as Base64Url into binary data.</summary>
707707
<returns>
708-
<see langword="true" /> if bytes decoded successfully, otherwise <see langword="false" />.</returns>
708+
<see langword="true" /> if bytes decoded successfully; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
709709
<remarks>To be added.</remarks>
710710
<exception cref="T:System.FormatException">
711711
<para>
@@ -740,7 +740,7 @@
740740
<param name="bytesWritten">When this method returns, contains the number of bytes written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized.</param>
741741
<summary>Decodes the span of UTF-8 encoded text represented as Base64Url into binary data.</summary>
742742
<returns>
743-
<see langword="true" /> if bytes decoded successfully, otherwise <see langword="false" />.</returns>
743+
<see langword="true" /> if bytes decoded successfully; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
744744
<remarks>To be added.</remarks>
745745
<exception cref="T:System.FormatException">
746746
<para>
@@ -775,7 +775,7 @@
775775
<param name="charsWritten">When this method returns, contains the number of chars written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized.</param>
776776
<summary>Encodes the span of binary data into unicode ASCII chars represented as Base64Url.</summary>
777777
<returns>
778-
<see langword="true" /> if chars encoded successfully, otherwise <see langword="false" />.</returns>
778+
<see langword="true" /> if chars encoded successfully; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
779779
<remarks>This implementation of the base64url encoding omits the optional padding characters.</remarks>
780780
</Docs>
781781
</Member>
@@ -805,7 +805,7 @@
805805
<param name="bytesWritten">When this method returns, contains the number of chars written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized.</param>
806806
<summary>Encodes the span of binary data into UTF-8 encoded chars represented as Base64Url.</summary>
807807
<returns>
808-
<see langword="true" /> if bytes encoded successfully, otherwise <see langword="false" />.</returns>
808+
<see langword="true" /> if bytes encoded successfully; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
809809
<remarks>This implementation of the base64url encoding omits the optional padding characters.</remarks>
810810
</Docs>
811811
</Member>
@@ -844,7 +844,7 @@
844844
<para>The encoded text output is larger than the binary data contained in the input (the operation inflates the data).</para>
845845
</summary>
846846
<returns>
847-
<see langword="true" /> if bytes encoded successfully, otherwise <see langword="false" />.</returns>
847+
<see langword="true" /> if bytes encoded successfully; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
848848
<remarks>This implementation of the base64url encoding omits the optional padding characters.</remarks>
849849
</Docs>
850850
</Member>

0 commit comments

Comments
 (0)