From 81b7d48d08acd022e933a95b50b93f6f56fb040a Mon Sep 17 00:00:00 2001 From: David Cantu Date: Fri, 26 Jul 2019 16:00:20 -0700 Subject: [PATCH 1/2] Adding documentation for new APIs in DecompressionMethods and MultipartContent classes. --- xml/System.Net.Http/MultipartContent.xml | 17 ++++++++++++++--- xml/System.Net/DecompressionMethods.xml | 4 ++-- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/xml/System.Net.Http/MultipartContent.xml b/xml/System.Net.Http/MultipartContent.xml index 9d3ceffefda..6e2448f4905 100644 --- a/xml/System.Net.Http/MultipartContent.xml +++ b/xml/System.Net.Http/MultipartContent.xml @@ -197,9 +197,20 @@ - To be added. - To be added. - To be added. + Serialize the HTTP content to a stream using the multipart/* encoding as an asynchronous operation. + The task object representing the asynchronous operation. + + to use a custom stream that contains an array with each HTTP content and its boundary encoded and serialized to a instance. + + This operation will not block. The returned object will complete after all of the content has been written to the memory stream. + + Once the operation completes, the 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. + + ]]> + diff --git a/xml/System.Net/DecompressionMethods.xml b/xml/System.Net/DecompressionMethods.xml index a290631c748..c3abb364f20 100644 --- a/xml/System.Net/DecompressionMethods.xml +++ b/xml/System.Net/DecompressionMethods.xml @@ -59,7 +59,7 @@ -1 - To be added. + Use all compression-decompression algorithms. @@ -85,7 +85,7 @@ 4 - To be added. + Use Brotli compression-decompression algorithm. From 54c53769fdda56b828bc7ff1ce4a0758342e7428 Mon Sep 17 00:00:00 2001 From: David Cantu Date: Fri, 26 Jul 2019 17:00:39 -0700 Subject: [PATCH 2/2] Apply suggestions from code review Co-Authored-By: Ron Petrusha --- xml/System.Net.Http/MultipartContent.xml | 8 ++++---- xml/System.Net/DecompressionMethods.xml | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/xml/System.Net.Http/MultipartContent.xml b/xml/System.Net.Http/MultipartContent.xml index 6e2448f4905..da589d44e52 100644 --- a/xml/System.Net.Http/MultipartContent.xml +++ b/xml/System.Net.Http/MultipartContent.xml @@ -197,17 +197,17 @@ - Serialize the HTTP content to a stream using the multipart/* encoding as an asynchronous operation. + Serializes the HTTP content to a stream using the multipart/* encoding as an asynchronous operation. The task object representing the asynchronous operation. to use a custom stream that contains an array with each HTTP content and its boundary encoded and serialized to a instance. + This method overrides to use a custom stream that contains an array, with each HTTP content and its boundary encoded and serialized to a instance. This operation will not block. The returned object will complete after all of the content has been written to the memory stream. - Once the operation completes, the 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. + Once the operation completes, the 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. ]]> @@ -422,4 +422,4 @@ - \ No newline at end of file + diff --git a/xml/System.Net/DecompressionMethods.xml b/xml/System.Net/DecompressionMethods.xml index c3abb364f20..c3cc08cf8d4 100644 --- a/xml/System.Net/DecompressionMethods.xml +++ b/xml/System.Net/DecompressionMethods.xml @@ -85,7 +85,7 @@ 4 - Use Brotli compression-decompression algorithm. + Use the Brotli compression-decompression algorithm. @@ -191,4 +191,4 @@ - \ No newline at end of file +