Skip to content

Commit 987bce8

Browse files
jozkeeRon Petrusha
andcommitted
Adding documentation for new APIs in DecompressionMethods and MultipartContent classes. (#2843)
* Adding documentation for new APIs in DecompressionMethods and MultipartContent classes. * Apply suggestions from code review Co-Authored-By: Ron Petrusha <[email protected]>
1 parent 5df7d99 commit 987bce8

File tree

2 files changed

+18
-7
lines changed

2 files changed

+18
-7
lines changed

xml/System.Net.Http/MultipartContent.xml

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -197,9 +197,20 @@
197197
</ReturnValue>
198198
<Parameters />
199199
<Docs>
200-
<summary>To be added.</summary>
201-
<returns>To be added.</returns>
202-
<remarks>To be added.</remarks>
200+
<summary>Serializes the HTTP content to a stream using the multipart/* encoding as an asynchronous operation.</summary>
201+
<returns>The task object representing the asynchronous operation.</returns>
202+
<remarks>
203+
<format type="text/markdown"><![CDATA[
204+
205+
## Remarks
206+
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.
207+
208+
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.
209+
210+
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.
211+
212+
]]></format>
213+
</remarks>
203214
</Docs>
204215
</Member>
205216
<Member MemberName="Dispose">
@@ -411,4 +422,4 @@
411422
</Docs>
412423
</Member>
413424
</Members>
414-
</Type>
425+
</Type>

xml/System.Net/DecompressionMethods.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
</ReturnValue>
6060
<MemberValue>-1</MemberValue>
6161
<Docs>
62-
<summary>To be added.</summary>
62+
<summary>Use all compression-decompression algorithms.</summary>
6363
</Docs>
6464
</Member>
6565
<Member MemberName="Brotli">
@@ -85,7 +85,7 @@
8585
</ReturnValue>
8686
<MemberValue>4</MemberValue>
8787
<Docs>
88-
<summary>To be added.</summary>
88+
<summary>Use the Brotli compression-decompression algorithm.</summary>
8989
</Docs>
9090
</Member>
9191
<Member MemberName="Deflate">
@@ -191,4 +191,4 @@
191191
</Docs>
192192
</Member>
193193
</Members>
194-
</Type>
194+
</Type>

0 commit comments

Comments
 (0)