Skip to content

Commit 5a071ee

Browse files
author
Ron Petrusha
authored
Update JsonEncodedText.xml
1 parent 9ee98a0 commit 5a071ee

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

xml/System.Text.Json/JsonEncodedText.xml

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
3131
## Remarks
3232
33-
This can be used to cache and store known strings used for writing JSON ahead of time by pre-encoding them up front.
33+
This type can be used to cache and store known strings used for writing JSON ahead of time by pre-encoding them up front.
3434
3535
]]>
3636
</format>
@@ -57,10 +57,10 @@ This can be used to cache and store known strings used for writing JSON ahead of
5757
</Parameters>
5858
<Docs>
5959
<param name="utf8Value">The UTF-8 encoded value to be transformed as JSON encoded text.</param>
60-
<summary>Encodes the UTF-8 text value as a JSON string.</summary>
61-
<returns>To be added.</returns>
60+
<summary>Encodes a UTF-8 encoded byte span as a JSON string.</summary>
61+
<returns>The JSON string.</returns>
6262
<remarks>To be added.</remarks>
63-
<exception cref="T:System.ArgumentException">Thrown when the specified value is too large or if it contains invalid UTF-8 bytes.</exception>
63+
<exception cref="T:System.ArgumentException"><paramref name'utf8Value" /> is too large or contains invalid UTF-8 bytes.</exception>
6464
</Docs>
6565
</Member>
6666
<Member MemberName="Encode">
@@ -83,10 +83,10 @@ This can be used to cache and store known strings used for writing JSON ahead of
8383
</Parameters>
8484
<Docs>
8585
<param name="value">The value to be transformed as JSON encoded text.</param>
86-
<summary>Encodes the text value as a JSON string.</summary>
87-
<returns>To be added.</returns>
86+
<summary>Encodes a UTF-16 encoded character span as a JSON string.</summary>
87+
<returns>The JSON string.</returns>
8888
<remarks>To be added.</remarks>
89-
<exception cref="T:System.ArgumentException">Thrown when the specified value is too large or if it contains invalid UTF-16 characters.</exception>
89+
<exception cref="T:System.ArgumentException"><paramref name="value" /> is too large or contains invalid UTF-16 characters.</exception>
9090
</Docs>
9191
</Member>
9292
<Member MemberName="Encode">
@@ -112,8 +112,8 @@ This can be used to cache and store known strings used for writing JSON ahead of
112112
<summary>Encodes the string text value as a JSON string.</summary>
113113
<returns>To be added.</returns>
114114
<remarks>To be added.</remarks>
115-
<exception cref="T:System.ArgumentNullException">Thrown if value is null.</exception>
116-
<exception cref="T:System.ArgumentException">Thrown when the specified value is too large or if it contains invalid UTF-16 characters.</exception>
115+
<exception cref="T:System.ArgumentNullException"><paramref name="value" /> is <see langword="null" />.</exception>
116+
<exception cref="T:System.ArgumentException"><paramref name="value" /> is too large or contains invalid UTF-16 characters.</exception>
117117
</Docs>
118118
</Member>
119119
<Member MemberName="EncodedUtf8Bytes">
@@ -132,8 +132,8 @@ This can be used to cache and store known strings used for writing JSON ahead of
132132
<ReturnType>System.ReadOnlySpan&lt;System.Byte&gt;</ReturnType>
133133
</ReturnValue>
134134
<Docs>
135-
<summary>Returns the UTF-8 encoded representation of the pre-encoded JSON text.</summary>
136-
<value>To be added.</value>
135+
<summary>Gets the UTF-8 encoded representation of the pre-encoded JSON text.</summary>
136+
<value>The UTF-8 encoded representation of the pre-encoded JSON text.</value>
137137
<remarks>To be added.</remarks>
138138
</Docs>
139139
</Member>
@@ -158,14 +158,14 @@ This can be used to cache and store known strings used for writing JSON ahead of
158158
<Docs>
159159
<param name="obj">To be added.</param>
160160
<summary>Determines whether this instance and a specified object, which must also be a <see cref="T:System.Text.Json.JsonEncodedText" /> instance, have the same value.</summary>
161-
<returns>To be added.</returns>
161+
<returns><see langword="true" /> if the current instance and <paramref name="obj" /> are equal; otherwise, <see langword="false" />.</returns>
162162
<remarks>
163163
<format type="text/markdown">
164164
<![CDATA[
165165
166166
## Remarks
167167
168-
If <xref:obj> is `null`, the method returns `false`.
168+
If `obj` is `null`, the method returns `false`.
169169
170170
]]>
171171
</format>
@@ -196,7 +196,7 @@ If <xref:obj> is `null`, the method returns `false`.
196196
<Docs>
197197
<param name="other">To be added.</param>
198198
<summary>Determines whether this instance and another specified <see cref="T:System.Text.Json.JsonEncodedText" /> instance have the same value.</summary>
199-
<returns>To be added.</returns>
199+
<returns><see langword="true" /> if this instance and <paramref name="other" /> have the same value; otherwise, <see langword="false" />.</returns>
200200
<remarks>
201201
<format type="text/markdown">
202202
<![CDATA[
@@ -228,14 +228,14 @@ Default instances of <xref:System.Text.Json.JsonEncodedText> are treated as equa
228228
<Parameters />
229229
<Docs>
230230
<summary>Returns the hash code for this <see cref="T:System.Text.Json.JsonEncodedText" />.</summary>
231-
<returns>To be added.</returns>
231+
<returns>The hash code for this instance.</returns>
232232
<remarks>
233233
<format type="text/markdown">
234234
<![CDATA[
235235
236236
## Remarks
237237
238-
Returns 0 on a default instance of <xref:System.Text.Json.JsonEncodedText>.
238+
This method returns 0 on a default instance of <xref:System.Text.Json.JsonEncodedText>.
239239
240240
]]>
241241
</format>
@@ -260,19 +260,19 @@ Returns 0 on a default instance of <xref:System.Text.Json.JsonEncodedText>.
260260
<Parameters />
261261
<Docs>
262262
<summary>Converts the value of this instance to a <see cref="T:System.String" />.</summary>
263-
<returns>Returns the underlying UTF-16 encoded string.</returns>
263+
<returns>The underlying UTF-16 encoded string.</returns>
264264
<remarks>
265265
<format type="text/markdown">
266266
<![CDATA[
267267
268268
## Remarks
269269
270-
Returns an empty string on a default instance of <xref:System.Text.Json.JsonEncodedText>.
270+
This method returns an empty string on a default instance of <xref:System.Text.Json.JsonEncodedText>.
271271
272272
]]>
273273
</format>
274274
</remarks>
275275
</Docs>
276276
</Member>
277277
</Members>
278-
</Type>
278+
</Type>

0 commit comments

Comments
 (0)