Skip to content

Commit 4c3160c

Browse files
gewarrengewarren
authored
Improve JSON descriptions (#5007)
1 parent b4eee72 commit 4c3160c

File tree

3 files changed

+44
-39
lines changed

3 files changed

+44
-39
lines changed

‎xml/System.Net.Http.Json/HttpClientJsonExtensions.xml

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>Contains the extension methods to send/receive HTTP content as JSON.</summary>
17+
<summary>Contains extension methods to send and receive HTTP content as JSON.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>
@@ -43,14 +43,14 @@
4343
<param name="requestUri">The Uri the request is sent to.</param>
4444
<param name="type">The type of the object to deserialize to and return.</param>
4545
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
46-
<summary>Send a GET request to the specified Uri and return the value resulting from deserialize the response body as JSON in an asynchronous operation.</summary>
46+
<summary>Sends a GET request to the specified Uri and returns the value that results from deserializing the response body as JSON in an asynchronous operation.</summary>
4747
<returns>The task object representing the asynchronous operation.</returns>
4848
<remarks>
4949
<format type="text/markdown"><![CDATA[
5050
5151
## Remarks
5252
53-
This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProperty=nameWithType> for deserialization.
53+
This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProperty=nameWithType> options for deserialization, whereas <xref:System.Text.Json.JsonSerializer> deserialization methods do not, by default.
5454
5555
]]></format>
5656
</remarks>
@@ -81,14 +81,14 @@ This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProper
8181
<param name="requestUri">The Uri the request is sent to.</param>
8282
<param name="type">The type of the object to deserialize to and return.</param>
8383
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
84-
<summary>Send a GET request to the specified Uri and return the value resulting from deserialize the response body as JSON in an asynchronous operation.</summary>
84+
<summary>Sends a GET request to the specified Uri and returns the value that results from deserializing the response body as JSON in an asynchronous operation.</summary>
8585
<returns>The task object representing the asynchronous operation.</returns>
8686
<remarks>
8787
<format type="text/markdown"><![CDATA[
8888
8989
## Remarks
9090
91-
This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProperty=nameWithType> for deserialization.
91+
This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProperty=nameWithType> options for deserialization, whereas <xref:System.Text.Json.JsonSerializer> deserialization methods do not, by default.
9292
9393
]]></format>
9494
</remarks>
@@ -119,9 +119,9 @@ This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProper
119119
<param name="client">The client used to send the request.</param>
120120
<param name="requestUri">The Uri the request is sent to.</param>
121121
<param name="type">The type of the object to deserialize to and return.</param>
122-
<param name="options">Options to control the behavior during deserialization, the default options are <see cref="F:System.Text.Json.JsonSerializerDefaults.Web" />.</param>
122+
<param name="options">Options to control the behavior during deserialization. The default options are those specified by <see cref="F:System.Text.Json.JsonSerializerDefaults.Web" />.</param>
123123
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
124-
<summary>Send a GET request to the specified Uri and return the value resulting from deserialize the response body as JSON in an asynchronous operation.</summary>
124+
<summary>Sends a GET request to the specified Uri and returns the value that results from deserializing the response body as JSON in an asynchronous operation.</summary>
125125
<returns>The task object representing the asynchronous operation.</returns>
126126
<remarks>To be added.</remarks>
127127
</Docs>
@@ -151,9 +151,9 @@ This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProper
151151
<param name="client">The client used to send the request.</param>
152152
<param name="requestUri">The Uri the request is sent to.</param>
153153
<param name="type">The type of the object to deserialize to and return.</param>
154-
<param name="options">Options to control the behavior during deserialization, the default options are <see cref="F:System.Text.Json.JsonSerializerDefaults.Web" />.</param>
154+
<param name="options">Options to control the behavior during deserialization. The default options are those specified by <see cref="F:System.Text.Json.JsonSerializerDefaults.Web" />.</param>
155155
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
156-
<summary>Send a GET request to the specified Uri and return the value resulting from deserialize the response body as JSON in an asynchronous operation.</summary>
156+
<summary>Sends a GET request to the specified Uri and returns the value that results from deserializing the response body as JSON in an asynchronous operation.</summary>
157157
<returns>The task object representing the asynchronous operation.</returns>
158158
<remarks>To be added.</remarks>
159159
</Docs>
@@ -185,14 +185,14 @@ This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProper
185185
<param name="client">The client used to send the request.</param>
186186
<param name="requestUri">The Uri the request is sent to.</param>
187187
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
188-
<summary>Send a GET request to the specified Uri and return the value resulting from deserialize the response body as JSON in an asynchronous operation.</summary>
188+
<summary>Sends a GET request to the specified Uri and returns the value that results from deserializing the response body as JSON in an asynchronous operation.</summary>
189189
<returns>The task object representing the asynchronous operation.</returns>
190190
<remarks>
191191
<format type="text/markdown"><![CDATA[
192192
193193
## Remarks
194194
195-
This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProperty=nameWithType> for deserialization.
195+
This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProperty=nameWithType> options for deserialization, whereas <xref:System.Text.Json.JsonSerializer> deserialization methods do not, by default.
196196
197197
]]></format>
198198
</remarks>
@@ -225,14 +225,14 @@ This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProper
225225
<param name="client">The client used to send the request.</param>
226226
<param name="requestUri">The Uri the request is sent to.</param>
227227
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
228-
<summary>Send a GET request to the specified Uri and return the value resulting from deserialize the response body as JSON in an asynchronous operation.</summary>
228+
<summary>Sends a GET request to the specified Uri and returns the value that results from deserializing the response body as JSON in an asynchronous operation.</summary>
229229
<returns>The task object representing the asynchronous operation.</returns>
230230
<remarks>
231231
<format type="text/markdown"><![CDATA[
232232
233233
## Remarks
234234
235-
This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProperty=nameWithType> for deserialization.
235+
This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProperty=nameWithType> options for deserialization, whereas <xref:System.Text.Json.JsonSerializer> deserialization methods do not, by default.
236236
237237
]]></format>
238238
</remarks>
@@ -265,9 +265,9 @@ This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProper
265265
<typeparam name="TValue">The target type to deserialize to.</typeparam>
266266
<param name="client">The client used to send the request.</param>
267267
<param name="requestUri">The Uri the request is sent to.</param>
268-
<param name="options">Options to control the behavior during deserialization, the default options are <see cref="F:System.Text.Json.JsonSerializerDefaults.Web" />.</param>
268+
<param name="options">Options to control the behavior during deserialization. The default options are those specified by <see cref="F:System.Text.Json.JsonSerializerDefaults.Web" />.</param>
269269
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
270-
<summary>Send a GET request to the specified Uri and return the value resulting from deserialize the response body as JSON in an asynchronous operation.</summary>
270+
<summary>Sends a GET request to the specified Uri and returns the value that results from deserializing the response body as JSON in an asynchronous operation.</summary>
271271
<returns>The task object representing the asynchronous operation.</returns>
272272
<remarks>To be added.</remarks>
273273
</Docs>
@@ -299,9 +299,9 @@ This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProper
299299
<typeparam name="TValue">The target type to deserialize to.</typeparam>
300300
<param name="client">The client used to send the request.</param>
301301
<param name="requestUri">The Uri the request is sent to.</param>
302-
<param name="options">Options to control the behavior during deserialization, the default options are <see cref="F:System.Text.Json.JsonSerializerDefaults.Web" />.</param>
302+
<param name="options">Options to control the behavior during deserialization. The default options are those specified by <see cref="F:System.Text.Json.JsonSerializerDefaults.Web" />.</param>
303303
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
304-
<summary>Send a GET request to the specified Uri and return the value resulting from deserialize the response body as JSON in an asynchronous operation.</summary>
304+
<summary>Sends a GET request to the specified Uri and returns the value that results from deserializing the response body as JSON in an asynchronous operation.</summary>
305305
<returns>The task object representing the asynchronous operation.</returns>
306306
<remarks>To be added.</remarks>
307307
</Docs>
@@ -336,14 +336,14 @@ This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProper
336336
<param name="requestUri">The Uri the request is sent to.</param>
337337
<param name="value">The value to serialize.</param>
338338
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
339-
<summary>Send a POST request to the specified Uri containing the <paramref name="value" /> serialized as JSON in the request body.</summary>
339+
<summary>Sends a POST request to the specified Uri containing the <paramref name="value" /> serialized as JSON in the request body.</summary>
340340
<returns>The task object representing the asynchronous operation.</returns>
341341
<remarks>
342342
<format type="text/markdown"><![CDATA[
343343
344344
## Remarks
345345
346-
This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProperty=nameWithType> for serialization.
346+
This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProperty=nameWithType> options for serialization, whereas <xref:System.Text.Json.JsonSerializer> serialization methods do not, by default.
347347
348348
]]></format>
349349
</remarks>
@@ -379,14 +379,14 @@ This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProper
379379
<param name="requestUri">The Uri the request is sent to.</param>
380380
<param name="value">The value to serialize.</param>
381381
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
382-
<summary>Send a POST request to the specified Uri containing the <paramref name="value" /> serialized as JSON in the request body.</summary>
382+
<summary>Sends a POST request to the specified Uri containing the <paramref name="value" /> serialized as JSON in the request body.</summary>
383383
<returns>The task object representing the asynchronous operation.</returns>
384384
<remarks>
385385
<format type="text/markdown"><![CDATA[
386386
387387
## Remarks
388388
389-
This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProperty=nameWithType> for serialization.
389+
This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProperty=nameWithType> options for serialization, whereas <xref:System.Text.Json.JsonSerializer> serialization methods do not, by default.
390390
391391
]]></format>
392392
</remarks>
@@ -421,9 +421,9 @@ This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProper
421421
<param name="client">The client used to send the request.</param>
422422
<param name="requestUri">The Uri the request is sent to.</param>
423423
<param name="value">The value to serialize.</param>
424-
<param name="options">Options to control the behavior during serialization, the default options are <see cref="F:System.Text.Json.JsonSerializerDefaults.Web" />.</param>
424+
<param name="options">Options to control the behavior during serialization. The default options are those specified by <see cref="F:System.Text.Json.JsonSerializerDefaults.Web" />.</param>
425425
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
426-
<summary>Send a POST request to the specified Uri containing the <paramref name="value" /> serialized as JSON in the request body.</summary>
426+
<summary>Sends a POST request to the specified Uri containing the <paramref name="value" /> serialized as JSON in the request body.</summary>
427427
<returns>The task object representing the asynchronous operation.</returns>
428428
<remarks>To be added.</remarks>
429429
</Docs>
@@ -457,9 +457,9 @@ This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProper
457457
<param name="client">The client used to send the request.</param>
458458
<param name="requestUri">The Uri the request is sent to.</param>
459459
<param name="value">The value to serialize.</param>
460-
<param name="options">Options to control the behavior during serialization, the default options are <see cref="F:System.Text.Json.JsonSerializerDefaults.Web" />.</param>
460+
<param name="options">Options to control the behavior during serialization. The default options are those specified by <see cref="F:System.Text.Json.JsonSerializerDefaults.Web" />.</param>
461461
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
462-
<summary>Send a POST request to the specified Uri containing the <paramref name="value" /> serialized as JSON in the request body.</summary>
462+
<summary>Sends a POST request to the specified Uri containing the <paramref name="value" /> serialized as JSON in the request body.</summary>
463463
<returns>The task object representing the asynchronous operation.</returns>
464464
<remarks>To be added.</remarks>
465465
</Docs>
@@ -501,7 +501,7 @@ This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProper
501501
502502
## Remarks
503503
504-
This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProperty=nameWithType> for serialization.
504+
This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProperty=nameWithType> options for serialization, whereas <xref:System.Text.Json.JsonSerializer> serialization methods do not, by default.
505505
506506
]]></format>
507507
</remarks>
@@ -544,7 +544,7 @@ This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProper
544544
545545
## Remarks
546546
547-
This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProperty=nameWithType> for serialization.
547+
This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProperty=nameWithType> options for serialization, whereas <xref:System.Text.Json.JsonSerializer> serialization methods do not, by default.
548548
549549
]]></format>
550550
</remarks>
@@ -579,7 +579,7 @@ This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProper
579579
<param name="client">The client used to send the request.</param>
580580
<param name="requestUri">The Uri the request is sent to.</param>
581581
<param name="value">The value to serialize.</param>
582-
<param name="options">Options to control the behavior during serialization, the default options are <see cref="F:System.Text.Json.JsonSerializerDefaults.Web" />.</param>
582+
<param name="options">Options to control the behavior during serialization. The default options are those specified by <see cref="F:System.Text.Json.JsonSerializerDefaults.Web" />.</param>
583583
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
584584
<summary>Send a PUT request to the specified Uri containing the <paramref name="value" /> serialized as JSON in the request body.</summary>
585585
<returns>The task object representing the asynchronous operation.</returns>
@@ -615,7 +615,7 @@ This method uses <xref:System.Text.Json.JsonSerializerDefaults.Web?displayProper
615615
<param name="client">The client used to send the request.</param>
616616
<param name="requestUri">The Uri the request is sent to.</param>
617617
<param name="value">The value to serialize.</param>
618-
<param name="options">Options to control the behavior during serialization, the default options are <see cref="F:System.Text.Json.JsonSerializerDefaults.Web" />.</param>
618+
<param name="options">Options to control the behavior during serialization. The default options are those specified by <see cref="F:System.Text.Json.JsonSerializerDefaults.Web" />.</param>
619619
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
620620
<summary>Send a PUT request to the specified Uri containing the <paramref name="value" /> serialized as JSON in the request body.</summary>
621621
<returns>The task object representing the asynchronous operation.</returns>

0 commit comments

Comments
 (0)