Skip to content

Add comments for new System.Net.Http.Json members #9302

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
carlossanlop merged 3 commits into from
Sep 18, 2023
Merged

Add comments for new System.Net.Http.Json members #9302

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a251202
Port System.Net.Http.Json docs
MihaZupan Sep 18, 2023
b1017e6
Add missing members
MihaZupan Sep 18, 2023
68c9f18
Wording
MihaZupan Sep 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Port System.Net.Http.Json docs
  • Loading branch information
@MihaZupan
MihaZupan committed Sep 18, 2023
commit a25120259e7c5678bb09f9b637bff379e253af8d
82 changes: 44 additions & 38 deletions xml/System.Net.Http.Json/HttpClientJsonExtensions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -738,13 +738,14 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="net-8.0" />
</Parameters>
<Docs>
<typeparam name="TValue">To be added.</typeparam>
<param name="client">To be added.</param>
<param name="requestUri">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="TValue">The target type to deserialize to.</typeparam>
<param name="client">The client used to send the request.</param>
<param name="requestUri">The Uri the request is sent to.</param>
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
<summary>Sends an <c>HTTP GET</c>request to the specified <paramref name="requestUri" /> and returns the value that results from deserializing the response body as JSON in an async enumerable operation.</summary>
<returns>An <see cref="T:System.Collections.Generic.IAsyncEnumerable`1" /> that represents the deserialized response body.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="client" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="GetFromJsonAsAsyncEnumerable&lt;TValue&gt;">
Expand Down Expand Up @@ -797,13 +798,14 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="net-8.0" />
</Parameters>
<Docs>
<typeparam name="TValue">To be added.</typeparam>
<param name="client">To be added.</param>
<param name="requestUri">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="TValue">The target type to deserialize to.</typeparam>
<param name="client">The client used to send the request.</param>
<param name="requestUri">The Uri the request is sent to.</param>
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
<summary>Sends an <c>HTTP GET</c>request to the specified <paramref name="requestUri" /> and returns the value that results from deserializing the response body as JSON in an async enumerable operation.</summary>
<returns>An <see cref="T:System.Collections.Generic.IAsyncEnumerable`1" /> that represents the deserialized response body.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="client" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="GetFromJsonAsAsyncEnumerable&lt;TValue&gt;">
Expand Down Expand Up @@ -864,14 +866,15 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" FrameworkAlternate="net-8.0" />
</Parameters>
<Docs>
<typeparam name="TValue">To be added.</typeparam>
<param name="client">To be added.</param>
<param name="requestUri">To be added.</param>
<typeparam name="TValue">The target type to deserialize to.</typeparam>
<param name="client">The client used to send the request.</param>
<param name="requestUri">The Uri the request is sent to.</param>
<param name="options">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
<summary>Sends an <c>HTTP GET</c> request to the specified <paramref name="requestUri" /> and returns the value that results from deserializing the response body as JSON in an async enumerable operation.</summary>
<returns>An <see cref="T:System.Collections.Generic.IAsyncEnumerable`1" /> that represents the deserialized response body.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="client" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="GetFromJsonAsAsyncEnumerable&lt;TValue&gt;">
Expand Down Expand Up @@ -922,14 +925,15 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" FrameworkAlternate="net-8.0" />
</Parameters>
<Docs>
<typeparam name="TValue">To be added.</typeparam>
<param name="client">To be added.</param>
<param name="requestUri">To be added.</param>
<param name="jsonTypeInfo">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="TValue">The target type to deserialize to.</typeparam>
<param name="client">The client used to send the request.</param>
<param name="requestUri">The Uri the request is sent to.</param>
<param name="jsonTypeInfo">Source generated JsonTypeInfo to control the behavior during deserialization.</param>
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
<summary>Sends an <c>HTTP GET</c>request to the specified <paramref name="requestUri" /> and returns the value that results from deserializing the response body as JSON in an async enumerable operation.</summary>
<returns>An <see cref="T:System.Collections.Generic.IAsyncEnumerable`1" /> that represents the deserialized response body.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="client" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="GetFromJsonAsAsyncEnumerable&lt;TValue&gt;">
Expand Down Expand Up @@ -983,14 +987,15 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" FrameworkAlternate="net-8.0" />
</Parameters>
<Docs>
<typeparam name="TValue">To be added.</typeparam>
<param name="client">To be added.</param>
<param name="requestUri">To be added.</param>
<typeparam name="TValue">The target type to deserialize to.</typeparam>
<param name="client">The client used to send the request.</param>
<param name="requestUri">The Uri the request is sent to.</param>
<param name="options">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
<summary>Sends an <c>HTTP GET</c>request to the specified <paramref name="requestUri" /> and returns the value that results from deserializing the response body as JSON in an async enumerable operation.</summary>
<returns>An <see cref="T:System.Collections.Generic.IAsyncEnumerable`1" /> that represents the deserialized response body.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="client" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="GetFromJsonAsAsyncEnumerable&lt;TValue&gt;">
Expand Down Expand Up @@ -1037,14 +1042,15 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" FrameworkAlternate="net-8.0" />
</Parameters>
<Docs>
<typeparam name="TValue">To be added.</typeparam>
<param name="client">To be added.</param>
<param name="requestUri">To be added.</param>
<param name="jsonTypeInfo">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="TValue">The target type to deserialize to.</typeparam>
<param name="client">The client used to send the request.</param>
<param name="requestUri">The Uri the request is sent to.</param>
<param name="jsonTypeInfo">Source generated JsonTypeInfo to control the behavior during deserialization.</param>
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
<summary>Sends an <c>HTTP GET</c>request to the specified <paramref name="requestUri" /> and returns the value that results from deserializing the response body as JSON in an async enumerable operation.</summary>
<returns>An <see cref="T:System.Collections.Generic.IAsyncEnumerable`1" /> that represents the deserialized response body.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="client" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="GetFromJsonAsync">
Expand Down
19 changes: 11 additions & 8 deletions xml/System.Net.Http.Json/HttpContentJsonExtensions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,13 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="net-8.0" />
</Parameters>
<Docs>
<typeparam name="TValue">To be added.</typeparam>
<typeparam name="TValue">The target type to deserialize to.</typeparam>
<param name="content">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Reads the HTTP content and returns the value that results from deserializing the content as JSON in an async enumerable operation.</summary>
<returns>An <see cref="T:System.Collections.Generic.IAsyncEnumerable`1" /> that represents the deserialized response body.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="content" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="ReadFromJsonAsAsyncEnumerable&lt;TValue&gt;">
Expand Down Expand Up @@ -134,13 +135,15 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="net-8.0" />
</Parameters>
<Docs>
<typeparam name="TValue">To be added.</typeparam>
<param name="content">To be added.</param>
<param name="options">To be added.</param>
<typeparam name="TValue">The target type to deserialize to.</typeparam>
<param name="content">The content to read from.</param>
<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>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Reads the HTTP content and returns the value that results from deserializing the content as JSON in an async enumerable operation.</summary>
<returns>An <see cref="T:System.Collections.Generic.IAsyncEnumerable`1" /> that represents the deserialized response body.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="content" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="ReadFromJsonAsAsyncEnumerable&lt;TValue&gt;">
Expand Down