From 53f4ca6d0941282f150d4aa02b22397abd274aad Mon Sep 17 00:00:00 2001 From: carlossanlop Date: Thu, 14 Nov 2019 14:31:53 -0800 Subject: [PATCH 1/4] Document System.IO.Pipelines.PipeOptions --- xml/System.IO.Pipelines/PipeOptions.xml | 40 ++++++++++++------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/xml/System.IO.Pipelines/PipeOptions.xml b/xml/System.IO.Pipelines/PipeOptions.xml index ac74e82b147..320f853fcdc 100644 --- a/xml/System.IO.Pipelines/PipeOptions.xml +++ b/xml/System.IO.Pipelines/PipeOptions.xml @@ -45,14 +45,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - Creates a new instance of . + The pool of memory blocks to be used for buffer management. + The to be used to execute callbacks. + The used to execute callbacks. + The number of bytes in the when starts blocking. + The number of bytes in the when stops blocking. + The minimum size of the segment requested from . + if asynchronous callbacks should be executed on the they were captured on; otherwise. This takes precedence over the schedulers specified in and . + Initializes a new instance with the specified parameters. To be added. @@ -75,7 +75,7 @@ Gets the default instance of . - To be added. + A instance, initialized without parameters. To be added. @@ -97,8 +97,8 @@ System.Int32 - Gets the minimum size of the segment requested from . - To be added. + Gets the minimum size of the segment requested from the . + An number that represents the minimum size of the segment requested from the . To be added. @@ -120,8 +120,8 @@ System.Int64 - Gets the amount of bytes in when starts blocking. - To be added. + Gets the number of bytes in the when starts blocking. + An that represents the number of bytes in the when starts blocking. To be added. @@ -143,8 +143,8 @@ System.Buffers.MemoryPool<System.Byte> - Gets the instances used for buffer management. - To be added. + Gets the instance used for buffer management. + A pool of memory blocks used for buffer management. To be added. @@ -167,7 +167,7 @@ Gets the used to execute callbacks. - To be added. + A that is used to execute callbacks. To be added. @@ -189,8 +189,8 @@ System.Int64 - Gets amount of bytes in when stops blocking. - To be added. + Gets the number of bytes in the when stops blocking. + An that represents the number of bytes in the when stops blocking. To be added. @@ -213,7 +213,7 @@ Gets a value that determines if asynchronous callbacks should be executed on the they were captured on. This takes precedence over the schedulers specified in and . - To be added. + if asynchronous callbacks should be executed on the they were captured on; otherwise. To be added. @@ -236,7 +236,7 @@ Gets the used to execute callbacks. - To be added. + A instance used to execute callbacks. To be added. From 1641df90ae72ec429b9daa32bc644764517a1d1a Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Thu, 14 Nov 2019 16:36:31 -0800 Subject: [PATCH 2/4] suggestions by halter73 and mairaw Co-Authored-By: Stephen Halter Co-Authored-By: Maira Wenzel --- xml/System.IO.Pipelines/PipeOptions.xml | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/xml/System.IO.Pipelines/PipeOptions.xml b/xml/System.IO.Pipelines/PipeOptions.xml index 320f853fcdc..da23fed80b3 100644 --- a/xml/System.IO.Pipelines/PipeOptions.xml +++ b/xml/System.IO.Pipelines/PipeOptions.xml @@ -46,13 +46,13 @@ The pool of memory blocks to be used for buffer management. - The to be used to execute callbacks. - The used to execute callbacks. - The number of bytes in the when starts blocking. + The to be used to execute callbacks and async continuations. + The used to execute callbacks and async continuations. + The number of bytes in the before starts blocking. A negative value prevents from ever blocking, effectively making the number of bytes in the unlimited. The number of bytes in the when stops blocking. The minimum size of the segment requested from . - if asynchronous callbacks should be executed on the they were captured on; otherwise. This takes precedence over the schedulers specified in and . - Initializes a new instance with the specified parameters. + if asynchronous continuations should be executed on the they were captured on; otherwise. This takes precedence over the schedulers specified in and . + Initializes a new instance of the class with the specified parameters. To be added. @@ -75,7 +75,7 @@ Gets the default instance of . - A instance, initialized without parameters. + A instance initialized with default parameters. To be added. @@ -98,7 +98,7 @@ Gets the minimum size of the segment requested from the . - An number that represents the minimum size of the segment requested from the . + The minimum size of the segment requested from the . To be added. @@ -121,7 +121,7 @@ Gets the number of bytes in the when starts blocking. - An that represents the number of bytes in the when starts blocking. + The number of bytes in the when starts blocking. To be added. @@ -143,7 +143,7 @@ System.Buffers.MemoryPool<System.Byte> - Gets the instance used for buffer management. + Gets the object used for buffer management. A pool of memory blocks used for buffer management. To be added. @@ -190,7 +190,7 @@ Gets the number of bytes in the when stops blocking. - An that represents the number of bytes in the when stops blocking. + The number of bytes in the when stops blocking. To be added. @@ -213,7 +213,7 @@ Gets a value that determines if asynchronous callbacks should be executed on the they were captured on. This takes precedence over the schedulers specified in and . - if asynchronous callbacks should be executed on the they were captured on; otherwise. + if asynchronous callbacks should be executed on the they were captured on; otherwise, . To be added. @@ -236,7 +236,7 @@ Gets the used to execute callbacks. - A instance used to execute callbacks. + A object used to execute callbacks. To be added. From dd22e8ea0cd897d13e82410637fe86f5caef3b5f Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Thu, 14 Nov 2019 16:42:50 -0800 Subject: [PATCH 3/4] suggestions by halter73 --- xml/System.IO.Pipelines/PipeOptions.xml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/xml/System.IO.Pipelines/PipeOptions.xml b/xml/System.IO.Pipelines/PipeOptions.xml index da23fed80b3..347ffbce638 100644 --- a/xml/System.IO.Pipelines/PipeOptions.xml +++ b/xml/System.IO.Pipelines/PipeOptions.xml @@ -166,8 +166,8 @@ System.IO.Pipelines.PipeScheduler - Gets the used to execute callbacks. - A that is used to execute callbacks. + Gets the used to execute callbacks and async continuations. + A that is used to execute callbacks and async continuations. To be added. @@ -212,8 +212,8 @@ System.Boolean - Gets a value that determines if asynchronous callbacks should be executed on the they were captured on. This takes precedence over the schedulers specified in and . - if asynchronous callbacks should be executed on the they were captured on; otherwise, . + Gets a value that determines if asynchronous callbacks and continuations should be executed on the they were captured on. This takes precedence over the schedulers specified in and . + if asynchronous callbacks and continuations should be executed on the they were captured on; otherwise, . To be added. @@ -235,8 +235,8 @@ System.IO.Pipelines.PipeScheduler - Gets the used to execute callbacks. - A object used to execute callbacks. + Gets the used to execute callbacks and async continuations. + A object used to execute callbacks and async continuations. To be added. From 53097bcaaec5d98adb38b927cc9731db19bbb6ae Mon Sep 17 00:00:00 2001 From: Maira Wenzel Date: Tue, 19 Nov 2019 12:23:05 -0800 Subject: [PATCH 4/4] instance -> object --- xml/System.IO.Pipelines/PipeOptions.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.IO.Pipelines/PipeOptions.xml b/xml/System.IO.Pipelines/PipeOptions.xml index 347ffbce638..fc539f3aaa7 100644 --- a/xml/System.IO.Pipelines/PipeOptions.xml +++ b/xml/System.IO.Pipelines/PipeOptions.xml @@ -75,7 +75,7 @@ Gets the default instance of . - A instance initialized with default parameters. + A object initialized with default parameters. To be added.