Skip to content

Commit 0a9aa7b

Browse files
carlossanlopjozkee
authored andcommitted
Automatically port System.Text.Encodings (#3151)
* Automatically port System.Text.Encodings * Fix encoding and endline * Remove first line * Update xml/System.Text.Encodings.Web/TextEncoder.xml * Fix isFinalBlock in EncodeUtf8 * Update xml/System.Text.Encodings.Web/TextEncoder.xml Co-Authored-By: David Cantu <[email protected]> * suggestions by rpetrusha and ahsonkhan Co-Authored-By: Ron Petrusha <[email protected]> * Update xml/System.Text.Encodings.Web/TextEncoder.xml Co-Authored-By: David Cantu <[email protected]>
1 parent 3fa6967 commit 0a9aa7b

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

xml/System.Text.Encodings.Web/TextEncoder.xml

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -221,14 +221,22 @@
221221
<Parameter Name="isFinalBlock" Type="System.Boolean" Index="4" FrameworkAlternate="netcore-3.0" />
222222
</Parameters>
223223
<Docs>
224-
<param name="source">To be added.</param>
225-
<param name="destination">To be added.</param>
226-
<param name="charsConsumed">To be added.</param>
227-
<param name="charsWritten">To be added.</param>
228-
<param name="isFinalBlock">To be added.</param>
229-
<summary>To be added.</summary>
230-
<returns>To be added.</returns>
231-
<remarks>To be added.</remarks>
224+
<param name="source">A source buffer containing the characters to encode.</param>
225+
<param name="destination">The destination buffer to which the encoded form of <paramref name="source" /> will be written.</param>
226+
<param name="charsConsumed">The number of characters consumed from the <paramref name="source" /> buffer.</param>
227+
<param name="charsWritten">The number of characters written to the <paramref name="destination" /> buffer.</param>
228+
<param name="isFinalBlock"><see langword="true" /> to indicate there is no further source data that needs to be encoded; otherwise, <see langword="false" />.</param>
229+
<summary>Encodes the supplied characters.</summary>
230+
<returns>An enumeration value that describes the result of the encoding operation.</returns>
231+
<remarks>
232+
<format type="text/markdown"><![CDATA[
233+
234+
## Remarks
235+
236+
The buffers `source` and `destination` must not overlap.
237+
238+
]]></format>
239+
</remarks>
232240
</Docs>
233241
</Member>
234242
<Member MemberName="EncodeUtf8">
@@ -257,8 +265,7 @@
257265
<param name="utf8Destination">The destination buffer to which the encoded form of <paramref name="utf8Source" /> will be written.</param>
258266
<param name="bytesConsumed">The number of bytes consumed from the <paramref name="utf8Source" /> buffer.</param>
259267
<param name="bytesWritten">The number of bytes written to the <paramref name="utf8Destination" /> buffer.</param>
260-
<param name="isFinalBlock">
261-
<see langword="true" /> if there is further source data that needs to be encoded; otherwise, <see langword="false" />.</param>
268+
<param name="isFinalBlock"><see langword="true" /> to indicate there is no further source data that needs to be encoded; otherwise, <see langword="false" />.</param>
262269
<summary>Encodes the supplied UTF-8 text.</summary>
263270
<returns>A status code that describes the result of the encoding operation.</returns>
264271
<remarks>

0 commit comments

Comments
 (0)