From 395da6339c992af98bd654ef509aaf03896657ba Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez Date: Mon, 15 Apr 2019 12:56:16 -0700 Subject: [PATCH 1/9] Port System.IO.Pipelines source code comments to Docs --- xml/System.IO.Pipelines/PipeReader.xml | 12 ++++++------ xml/System.IO.Pipelines/PipeWriter.xml | 12 ++++++------ xml/System.IO.Pipelines/StreamPipeExtensions.xml | 10 +++++----- 3 files changed, 17 insertions(+), 17 deletions(-) diff --git a/xml/System.IO.Pipelines/PipeReader.xml b/xml/System.IO.Pipelines/PipeReader.xml index 76a31f44be5..ff6cf9527ec 100644 --- a/xml/System.IO.Pipelines/PipeReader.xml +++ b/xml/System.IO.Pipelines/PipeReader.xml @@ -113,8 +113,8 @@ - To be added. - To be added. + Returns a that wraps the . + The . To be added. @@ -183,10 +183,10 @@ - To be added. - To be added. - To be added. - To be added. + The stream to which the contents of the current stream will be copied. + The token to monitor for cancellation requests. The default value is . + Asynchronously reads the bytes from the and writes them to the specified stream, using a specified buffer size and cancellation token. + A task that represents the asynchronous copy operation. To be added. diff --git a/xml/System.IO.Pipelines/PipeWriter.xml b/xml/System.IO.Pipelines/PipeWriter.xml index 42728d31bc4..297e0f3c75a 100644 --- a/xml/System.IO.Pipelines/PipeWriter.xml +++ b/xml/System.IO.Pipelines/PipeWriter.xml @@ -90,8 +90,8 @@ - To be added. - To be added. + Returns a that wraps the . + The . To be added. @@ -160,10 +160,10 @@ - To be added. - To be added. - To be added. - To be added. + The stream from which the contents will be copied. + The token to monitor for cancellation requests. The default value is . + Asynchronously reads the bytes from the specified stream and writes them to the . + A task that represents the asynchronous copy operation. To be added. diff --git a/xml/System.IO.Pipelines/StreamPipeExtensions.xml b/xml/System.IO.Pipelines/StreamPipeExtensions.xml index 0255df53242..1e821f29b97 100644 --- a/xml/System.IO.Pipelines/StreamPipeExtensions.xml +++ b/xml/System.IO.Pipelines/StreamPipeExtensions.xml @@ -37,11 +37,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The stream from which the contents of the current stream will be copied. + The to which the contents of the source stream will be copied. + The token to monitor for cancellation requests. The default value is . + Asynchronously reads the bytes from the and writes them to the specified , using a cancellation token. + A task that represents the asynchronous copy operation. To be added. From 06a7f1dec715c59b917b0c139e4451ee89b3b176 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Tue, 16 Apr 2019 12:27:42 -0700 Subject: [PATCH 2/9] Update xml/System.IO.Pipelines/PipeReader.xml Thank you very much for adding the missing returns value. Co-Authored-By: carlossanlop <1175054+carlossanlop@users.noreply.github.com> --- xml/System.IO.Pipelines/PipeReader.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System.IO.Pipelines/PipeReader.xml b/xml/System.IO.Pipelines/PipeReader.xml index ff6cf9527ec..4e17c14b1d9 100644 --- a/xml/System.IO.Pipelines/PipeReader.xml +++ b/xml/System.IO.Pipelines/PipeReader.xml @@ -114,7 +114,7 @@ Returns a that wraps the . - The . + The stream that wraps the . To be added. @@ -272,4 +272,4 @@ - \ No newline at end of file + From ebc6039b7679538cfe8d8dfeae51e2356506b77a Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Tue, 16 Apr 2019 12:28:14 -0700 Subject: [PATCH 3/9] Update xml/System.IO.Pipelines/PipeReader.xml Nice catch. Thank you for the correction. Co-Authored-By: carlossanlop <1175054+carlossanlop@users.noreply.github.com> --- xml/System.IO.Pipelines/PipeReader.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.IO.Pipelines/PipeReader.xml b/xml/System.IO.Pipelines/PipeReader.xml index 4e17c14b1d9..033181e712e 100644 --- a/xml/System.IO.Pipelines/PipeReader.xml +++ b/xml/System.IO.Pipelines/PipeReader.xml @@ -185,7 +185,7 @@ The stream to which the contents of the current stream will be copied. The token to monitor for cancellation requests. The default value is . - Asynchronously reads the bytes from the and writes them to the specified stream, using a specified buffer size and cancellation token. + Asynchronously reads the bytes from the and writes them to the specified stream, using a specified cancellation token. A task that represents the asynchronous copy operation. To be added. From a93d8ccd9d7f228f05d7bf9caef2b104abc06683 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Tue, 16 Apr 2019 12:29:28 -0700 Subject: [PATCH 4/9] Update xml/System.IO.Pipelines/StreamPipeExtensions.xml Co-Authored-By: carlossanlop <1175054+carlossanlop@users.noreply.github.com> --- xml/System.IO.Pipelines/StreamPipeExtensions.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System.IO.Pipelines/StreamPipeExtensions.xml b/xml/System.IO.Pipelines/StreamPipeExtensions.xml index 1e821f29b97..c1444b8b50c 100644 --- a/xml/System.IO.Pipelines/StreamPipeExtensions.xml +++ b/xml/System.IO.Pipelines/StreamPipeExtensions.xml @@ -38,7 +38,7 @@ The stream from which the contents of the current stream will be copied. - The to which the contents of the source stream will be copied. + The writer to which the contents of the source stream will be copied. The token to monitor for cancellation requests. The default value is . Asynchronously reads the bytes from the and writes them to the specified , using a cancellation token. A task that represents the asynchronous copy operation. @@ -46,4 +46,4 @@ - \ No newline at end of file + From ecf2596d209a2602c22fe19cc234e10d70fce6ad Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez Date: Thu, 18 Apr 2019 12:17:56 -0700 Subject: [PATCH 5/9] Added missing comments suggested by rpetrusha in PR. --- xml/System.IO.Pipelines/PipeReader.xml | 2 +- xml/System.IO.Pipelines/PipeWriter.xml | 44 +++++++++++++++++++------- 2 files changed, 34 insertions(+), 12 deletions(-) diff --git a/xml/System.IO.Pipelines/PipeReader.xml b/xml/System.IO.Pipelines/PipeReader.xml index ff6cf9527ec..7a3ceed4a86 100644 --- a/xml/System.IO.Pipelines/PipeReader.xml +++ b/xml/System.IO.Pipelines/PipeReader.xml @@ -35,7 +35,7 @@ - To be added. + Initializes a new instance of the class. To be added. diff --git a/xml/System.IO.Pipelines/PipeWriter.xml b/xml/System.IO.Pipelines/PipeWriter.xml index 297e0f3c75a..b0fb3fb4b1e 100644 --- a/xml/System.IO.Pipelines/PipeWriter.xml +++ b/xml/System.IO.Pipelines/PipeWriter.xml @@ -39,7 +39,7 @@ - To be added. + Initializes a new instance of the class. To be added. @@ -67,8 +67,8 @@ - To be added. - To be added. + The number of bytes written to the or . + Notifies the that bytes were written to the output or . You must request a new buffer after calling to continue writing more data; you cannot write to a previously acquired buffer. To be added. @@ -215,10 +215,21 @@ - To be added. - To be added. - To be added. - To be added. + The minimum length of the returned . If 0, a non-empty memory buffer is returned. + Returns a to write to that is at least the requested size, as specified by the parameter. + A memory buffer of at least bytes. If is 0, returns a non-empty buffer. + + , but it throw an if the requested buffer size is not available. + +You must request a new buffer after calling to continue writing more data; you cannot write to a previously acquired buffer. + + ]]> + The requested buffer size is not available. @@ -245,10 +256,21 @@ - To be added. - To be added. - To be added. - To be added. + The minimum length of the returned . If 0, a non-empty buffer is returned. + Returns a to write to that is at least the requested size, as specified by the parameter. + A buffer of at least bytes. If is 0, returns a non-empty buffer. + + , but it throws an if the requested buffer size is not available. + +You must request a new buffer after calling to continue writing more data; you cannot write to a previously acquired buffer. + + ]]> + + The requested buffer size is not available. From 95417464998a87a51876095a079369db17771ca1 Mon Sep 17 00:00:00 2001 From: Maira Wenzel Date: Tue, 23 Apr 2019 14:35:54 -0700 Subject: [PATCH 6/9] close tag --- xml/System.IO.Pipelines/PipeWriter.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System.IO.Pipelines/PipeWriter.xml b/xml/System.IO.Pipelines/PipeWriter.xml index b0fb3fb4b1e..f1c255b27c3 100644 --- a/xml/System.IO.Pipelines/PipeWriter.xml +++ b/xml/System.IO.Pipelines/PipeWriter.xml @@ -228,7 +228,7 @@ This method never returns , but it throw a You must request a new buffer after calling to continue writing more data; you cannot write to a previously acquired buffer. ]]> - The requested buffer size is not available. @@ -330,4 +330,4 @@ You must request a new buffer after calling The number of bytes written to the or . - Notifies the that bytes were written to the output or . You must request a new buffer after calling to continue writing more data; you cannot write to a previously acquired buffer. + Notifies the that bytes were written to the output or . You must request a new buffer after calling to continue writing more data; you cannot write to a previously acquired buffer. To be added. From 3d46865f85538a79ea7f72e713fa517848e4437b Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Thu, 25 Apr 2019 11:36:25 -0700 Subject: [PATCH 8/9] Update PipeWriter.xml --- xml/System.IO.Pipelines/PipeWriter.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System.IO.Pipelines/PipeWriter.xml b/xml/System.IO.Pipelines/PipeWriter.xml index cfee334da3f..be3e5aae40e 100644 --- a/xml/System.IO.Pipelines/PipeWriter.xml +++ b/xml/System.IO.Pipelines/PipeWriter.xml @@ -223,9 +223,9 @@ There is no guarantee that successive calls will return the same buffer or the same-sized buffer. -This method never returns , but it throw an if the requested buffer size is not available. +This method never returns , but it throws an if the requested buffer size is not available. -You must request a new buffer after calling to continue writing more data; you cannot write to a previously acquired buffer. +You must request a new buffer after calling to continue writing more data; you cannot write to a previously acquired buffer. ]]> From 9507a5a360ac6185b09e5a0469186abfa8513dac Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Fri, 26 Apr 2019 08:32:26 -0700 Subject: [PATCH 9/9] Apply suggestions from code review Suggestions from anurse and mairaw. Co-Authored-By: carlossanlop <1175054+carlossanlop@users.noreply.github.com> --- xml/System.IO.Pipelines/PipeReader.xml | 4 ++-- xml/System.IO.Pipelines/PipeWriter.xml | 14 +++++++------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/xml/System.IO.Pipelines/PipeReader.xml b/xml/System.IO.Pipelines/PipeReader.xml index 2f9566ba96f..3e5a342fe26 100644 --- a/xml/System.IO.Pipelines/PipeReader.xml +++ b/xml/System.IO.Pipelines/PipeReader.xml @@ -35,7 +35,7 @@ - Initializes a new instance of the class. + Initializes a new instance of the class. To be added. @@ -113,7 +113,7 @@ - Returns a that wraps the . + Returns a read-only that wraps the . The stream that wraps the . To be added. diff --git a/xml/System.IO.Pipelines/PipeWriter.xml b/xml/System.IO.Pipelines/PipeWriter.xml index be3e5aae40e..ae4684f328d 100644 --- a/xml/System.IO.Pipelines/PipeWriter.xml +++ b/xml/System.IO.Pipelines/PipeWriter.xml @@ -68,7 +68,7 @@ The number of bytes written to the or . - Notifies the that bytes were written to the output or . You must request a new buffer after calling to continue writing more data; you cannot write to a previously acquired buffer. + Notifies the that bytes were written to the output or . You must request a new buffer after calling to continue writing more data; you cannot write to a previously acquired buffer. To be added. @@ -90,7 +90,7 @@ - Returns a that wraps the . + Returns a write-only that wraps the . The . To be added. @@ -215,9 +215,9 @@ - The minimum length of the returned . If 0, a non-empty memory buffer is returned. + The minimum length of the returned . If 0, a non-empty memory buffer of arbitrary size is returned. Returns a to write to that is at least the requested size, as specified by the parameter. - A memory buffer of at least bytes. If is 0, returns a non-empty buffer. + A memory buffer of at least bytes. If is 0, returns a non-empty buffer of arbitrary size. - The minimum length of the returned . If 0, a non-empty buffer is returned. + The minimum length of the returned . If 0, a non-empty buffer of arbitrary size is returned. Returns a to write to that is at least the requested size, as specified by the parameter. - A buffer of at least bytes. If is 0, returns a non-empty buffer. + A buffer of at least bytes. If is 0, returns a non-empty buffer of arbitrary size. , but it throws an if the requested buffer size is not available. -You must request a new buffer after calling to continue writing more data; you cannot write to a previously acquired buffer. +You must request a new buffer after calling to continue writing more data; you cannot write to a previously acquired buffer. ]]>