Skip to content

Adding documentation for new APIs in DecompressionMethods and MultipartContent classes. #2843

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
merged 2 commits into from
Jul 29, 2019
Merged

Adding documentation for new APIs in DecompressionMethods and MultipartContent classes. #2843

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81b7d48
Adding documentation for new APIs in DecompressionMethods and Multipa…
jozkee Jul 26, 2019
54c5376
Apply suggestions from code review
jozkee Jul 27, 2019
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
19 changes: 15 additions & 4 deletions xml/System.Net.Http/MultipartContent.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,9 +197,20 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Serializes the HTTP content to a stream using the multipart/* encoding as an asynchronous operation.</summary>
<returns>The task object representing the asynchronous operation.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
This method overrides <xref:System.Net.Http.HttpContent.CreateContentReadStreamAsync%2A?displayProperty=nameWithType> to use a custom stream that contains an array, with each HTTP content and its boundary encoded and serialized to a <xref:System.IO.MemoryStream> instance.

This operation will not block. The returned <xref:System.Threading.Tasks.Task%601> object will complete after all of the content has been written to the memory stream.

Once the operation completes, the <xref:System.Threading.Tasks.Task%601.Result%2A?displayProperty=nameWithType> property on the returned task object contains the stream that represents the multipart/* encoded HTTP content. The returned stream can then be used to read the content using various stream APIs.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
Expand Down Expand Up @@ -411,4 +422,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>
6 changes: 3 additions & 3 deletions xml/System.Net/DecompressionMethods.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
</ReturnValue>
<MemberValue>-1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Use all compression-decompression algorithms.</summary>
</Docs>
</Member>
<Member MemberName="Brotli">
Expand All @@ -85,7 +85,7 @@
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Use the Brotli compression-decompression algorithm.</summary>
</Docs>
</Member>
<Member MemberName="Deflate">
Expand Down Expand Up @@ -191,4 +191,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>