From f5ffebdace171fc3c5ede80971343197b4bc40ad Mon Sep 17 00:00:00 2001 From: carlossanlop Date: Mon, 1 Jul 2019 14:12:39 -0700 Subject: [PATCH 01/10] Automatic port of System.Buffers triple slash comments --- xml/System.Buffers/ArrayBufferWriter`1.xml | 66 +++++-- xml/System.Buffers/BuffersExtensions.xml | 3 + xml/System.Buffers/ReadOnlySequence`1.xml | 2 +- .../SequenceReaderExtensions.xml | 12 +- xml/System.Buffers/SequenceReader`1.xml | 174 +++++++++--------- 5 files changed, 150 insertions(+), 107 deletions(-) diff --git a/xml/System.Buffers/ArrayBufferWriter`1.xml b/xml/System.Buffers/ArrayBufferWriter`1.xml index bcac2db8bb1..8da5ef1f066 100644 --- a/xml/System.Buffers/ArrayBufferWriter`1.xml +++ b/xml/System.Buffers/ArrayBufferWriter`1.xml @@ -22,7 +22,7 @@ To be added. - To be added. + Represents a heap-based, array-backed output sink into which data can be written. To be added. @@ -39,7 +39,7 @@ - To be added. + Creates an instance of an , in which data can be written to, with the default initial capacity. To be added. @@ -59,9 +59,12 @@ - To be added. - To be added. + The minimum capacity with which to initialize the underlying buffer. + Creates an instance of an , in which data can be written to, with an initial capacity specified. To be added. + + Thrown when is not positive (i.e. less than or equal to 0). + @@ -87,8 +90,18 @@ To be added. - To be added. - To be added. + Notifies that amount of data was written to the output / + + + + + Thrown when is negative. + + + Thrown when attempting to advance past the end of the underlying buffer. + @@ -107,7 +120,7 @@ System.Int32 - To be added. + Returns the total amount of space within the underlying buffer. To be added. To be added. @@ -129,8 +142,12 @@ - To be added. - To be added. + Clears the data written to the underlying buffer. + + before trying to re-use it. + ]]> + @@ -149,7 +166,7 @@ System.Int32 - To be added. + Returns the amount of space available that can still be written into without forcing the underlying buffer to grow. To be added. To be added. @@ -176,9 +193,16 @@ To be added. - To be added. + Returns a to write to that is at least the requested length (specified by ). If no is provided (or it's equal to 0), some non-empty buffer is returned. To be added. - To be added. + + . + ]]> + + + Thrown when is negative. + @@ -203,9 +227,17 @@ To be added. - To be added. + Returns a to write to that is at least the requested length (specified by ). + If no is provided (or it's equal to 0), some non-empty buffer is returned. To be added. - To be added. + + . + ]]> + + + Thrown when is negative. + @@ -224,7 +256,7 @@ System.Int32 - To be added. + Returns the amount of data written to the underlying buffer so far. To be added. To be added. @@ -245,7 +277,7 @@ System.ReadOnlyMemory<T> - To be added. + Returns the data written to the underlying buffer so far, as a . To be added. To be added. @@ -266,7 +298,7 @@ System.ReadOnlySpan<T> - To be added. + Returns the data written to the underlying buffer so far, as a . To be added. To be added. diff --git a/xml/System.Buffers/BuffersExtensions.xml b/xml/System.Buffers/BuffersExtensions.xml index 55fce2a470e..fc7d3809c0b 100644 --- a/xml/System.Buffers/BuffersExtensions.xml +++ b/xml/System.Buffers/BuffersExtensions.xml @@ -173,6 +173,9 @@ The read-only span to be written to . Writes the contents of to . To be added. + + Thrown when the is shorter than the . + diff --git a/xml/System.Buffers/ReadOnlySequence`1.xml b/xml/System.Buffers/ReadOnlySequence`1.xml index 6e60783c150..8bce70219f9 100644 --- a/xml/System.Buffers/ReadOnlySequence`1.xml +++ b/xml/System.Buffers/ReadOnlySequence`1.xml @@ -255,7 +255,7 @@ The consumer is expected to manage the lifetime of memory until from the first segment. To be added. To be added. diff --git a/xml/System.Buffers/SequenceReaderExtensions.xml b/xml/System.Buffers/SequenceReaderExtensions.xml index 59e26ff5db5..52a90229847 100644 --- a/xml/System.Buffers/SequenceReaderExtensions.xml +++ b/xml/System.Buffers/SequenceReaderExtensions.xml @@ -40,8 +40,8 @@ To be added. To be added. - To be added. - To be added. + Reads an as big endian. + if there wasn't enough data for an . To be added. @@ -67,8 +67,8 @@ To be added. To be added. - To be added. - To be added. + Reads an as big endian. + if there wasn't enough data for an . To be added. @@ -94,8 +94,8 @@ To be added. To be added. - To be added. - To be added. + Reads an as little endian. + if there wasn't enough data for an . To be added. diff --git a/xml/System.Buffers/SequenceReader`1.xml b/xml/System.Buffers/SequenceReader`1.xml index 8e5c6d00106..5506b581d42 100644 --- a/xml/System.Buffers/SequenceReader`1.xml +++ b/xml/System.Buffers/SequenceReader`1.xml @@ -51,7 +51,7 @@ To be added. - To be added. + Creates a over the given . To be added. @@ -75,7 +75,7 @@ To be added. - To be added. + Moves the reader ahead the specified number of items. To be added. @@ -99,8 +99,8 @@ To be added. - To be added. - To be added. + Advances past consecutive instances of the given . + How many positions the reader has been advanced. To be added. @@ -124,8 +124,8 @@ To be added. - To be added. - To be added. + Skips consecutive instances of any of the given . + How many positions the reader has been advanced. To be added. @@ -151,8 +151,8 @@ To be added. To be added. - To be added. - To be added. + Advances past consecutive instances of any of the given values. + How many positions the reader has been advanced. To be added. @@ -180,8 +180,8 @@ To be added. To be added. To be added. - To be added. - To be added. + Advances past consecutive instances of any of the given values. + How many positions the reader has been advanced. To be added. @@ -211,8 +211,8 @@ To be added. To be added. To be added. - To be added. - To be added. + Advances past consecutive instances of any of the given values. + How many positions the reader has been advanced. To be added. @@ -237,7 +237,7 @@ System.Int64 - To be added. + The total number of 's processed by the reader. To be added. To be added. @@ -263,7 +263,7 @@ System.ReadOnlySpan<T> - To be added. + The current segment in the as a span. To be added. To be added. @@ -289,7 +289,7 @@ System.Int32 - To be added. + The index in the . To be added. To be added. @@ -315,7 +315,7 @@ System.Boolean - To be added. + when there is no more data in the . To be added. To be added. @@ -339,9 +339,9 @@ - To be added. - To be added. - To be added. + The span to compare the next items to. + Move past the values if found. + Checks to see if the given values are next. To be added. To be added. @@ -365,9 +365,9 @@ - To be added. - To be added. - To be added. + The value to compare the next items to. + Move past the value if found. + Checks to see if the given value is next. To be added. To be added. @@ -393,7 +393,7 @@ System.Int64 - To be added. + Count of in the reader's . To be added. To be added. @@ -419,7 +419,7 @@ System.SequencePosition - To be added. + The current position in the . To be added. To be added. @@ -445,7 +445,7 @@ System.Int64 - To be added. + Remaining 's in the reader's . To be added. To be added. @@ -470,8 +470,11 @@ To be added. - To be added. + Moves the reader back the specified number of items. To be added. + + Thrown if trying to rewind a negative amount or more than . + @@ -495,7 +498,7 @@ System.Buffers.ReadOnlySequence<T> - To be added. + The underlying for the reader. To be added. To be added. @@ -519,10 +522,10 @@ - To be added. - To be added. - To be added. - To be added. + The delimiter to search for. + True to move past the if found. + Advances until the given , if found. + if the given was found. To be added. @@ -545,10 +548,10 @@ - To be added. - To be added. - To be added. - To be added. + The delimiters to search for. + True to move past the first found instance of any of the given . + Advances until any of the given , if found. + if any of the given were found. To be added. @@ -576,10 +579,15 @@ - To be added. - To be added. - To be added. - To be added. + Destination span to copy to. + Copies data from the current to the given span if there + is enough data to fill it. + if there is enough data to completely fill the span. + + can be used. + ]]> + @@ -606,9 +614,9 @@ - To be added. - To be added. - To be added. + The next value or default if at the end. + Peeks at the next value without advancing the reader. + if at the end of the reader. To be added. @@ -631,9 +639,9 @@ - To be added. - To be added. - To be added. + The next value or default if at the end. + Read the next value and advance the reader. + if at the end of the reader. To be added. @@ -657,11 +665,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The read data, if any. + The multi (T) delimiter. + to move past the if found. + Tries to read data until the entire given matches. + if the was found. To be added. @@ -685,11 +693,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The read data, if any. + The delimiter to look for. + to move past the if found. + Tries to read everything up to the given . + if the was found. To be added. @@ -713,11 +721,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The read data, if any. + The delimiter to look for. + to move past the if found. + Tries to read everything up to the given . + if the was found. To be added. @@ -742,12 +750,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The read data, if any. + The delimiter to look for. + If found prior to it will skip that occurrence. + to move past the if found. + Tries to read everything up to the given , ignoring delimiters that are preceded by . + if the was found. To be added. @@ -772,12 +780,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The read data, if any. + The delimiter to look for. + If found prior to it will skip that occurrence. + to move past the if found. + Tries to read everything up to the given , ignoring delimiters that are preceded by . + if the was found. To be added. @@ -801,11 +809,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The read data, if any. + The delimiters to look for. + to move past the first found instance of any of the given . + Tries to read everything up to the given . + if any of the were found. To be added. @@ -829,11 +837,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The read data, if any. + The delimiters to look for. + to move past the first found instance of any of the given . + Tries to read everything up to the given . + if any of the were found. To be added. @@ -858,7 +866,7 @@ System.ReadOnlySpan<T> - To be added. + The unread portion of the . To be added. To be added. From 9bdbf389cffd112c0b14554c712363e8bb6734a7 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Wed, 3 Jul 2019 14:12:21 -0700 Subject: [PATCH 02/10] rpetrusha suggestions minus 3 Co-Authored-By: Ron Petrusha --- xml/System.Buffers/ArrayBufferWriter`1.xml | 52 +++--- xml/System.Buffers/BuffersExtensions.xml | 4 +- xml/System.Buffers/ReadOnlySequence`1.xml | 4 +- .../SequenceReaderExtensions.xml | 14 +- xml/System.Buffers/SequenceReader`1.xml | 160 +++++++++--------- 5 files changed, 117 insertions(+), 117 deletions(-) diff --git a/xml/System.Buffers/ArrayBufferWriter`1.xml b/xml/System.Buffers/ArrayBufferWriter`1.xml index 8da5ef1f066..319ba0d19b7 100644 --- a/xml/System.Buffers/ArrayBufferWriter`1.xml +++ b/xml/System.Buffers/ArrayBufferWriter`1.xml @@ -39,7 +39,7 @@ - Creates an instance of an , in which data can be written to, with the default initial capacity. + Creates an instance of an to which data can be written, with the default initial capacity. To be added. @@ -60,10 +60,10 @@ The minimum capacity with which to initialize the underlying buffer. - Creates an instance of an , in which data can be written to, with an initial capacity specified. + Creates an instance of an to which data can be written, with a specified initial capacity. To be added. - Thrown when is not positive (i.e. less than or equal to 0). + is less than or equal to 0. @@ -89,18 +89,18 @@ - To be added. - Notifies that amount of data was written to the output / + The number of items written. + Notifies the that items were written to the output / - Thrown when is negative. + is negative. - Thrown when attempting to advance past the end of the underlying buffer. + The method call attempts to advance past the end of the underlying buffer. @@ -120,8 +120,8 @@ You must request a new buffer after calling Advance to continue writing more dat System.Int32 - Returns the total amount of space within the underlying buffer. - To be added. + Gets the total amount of space within the underlying buffer. + The total capacity of the underlying buffer. To be added. @@ -145,7 +145,7 @@ You must request a new buffer after calling Advance to continue writing more dat Clears the data written to the underlying buffer. before trying to re-use it. +You must clear the before trying to reuse it. ]]> @@ -166,8 +166,8 @@ You must clear the before trying to re System.Int32 - Returns the amount of space available that can still be written into without forcing the underlying buffer to grow. - To be added. + Gets the amount of available space that can be written to without forcing the underlying buffer to grow. + The space available for writing without forcing the underlying buffer to grow. To be added. @@ -192,16 +192,16 @@ You must clear the before trying to re - To be added. - Returns a to write to that is at least the requested length (specified by ). If no is provided (or it's equal to 0), some non-empty buffer is returned. - To be added. + The minimum requested length of the . + Returns a to write to that is at least the length specified by . + A whose length is at least . If is not provided or is equal to 0, some non-empty buffer is returned. . ]]> - Thrown when is negative. + is negative. @@ -227,16 +227,16 @@ This will never return an empty . To be added. - Returns a to write to that is at least the requested length (specified by ). - If no is provided (or it's equal to 0), some non-empty buffer is returned. - To be added. + Returns a to write to that is at least a specified length. + + A span of at least in length. If is not provided or is equal to 0, some non-empty buffer is returned. . ]]> - Thrown when is negative. + is negative. @@ -256,8 +256,8 @@ This will never return an empty . System.Int32 - Returns the amount of data written to the underlying buffer so far. - To be added. + Gets the amount of data written to the underlying buffer. + The amount of data written to the underlying buffer. To be added. @@ -277,8 +277,8 @@ This will never return an empty . System.ReadOnlyMemory<T> - Returns the data written to the underlying buffer so far, as a . - To be added. + Gets a that contains the data written to the underlying buffer so far. + The data written to the underlying buffer. To be added. @@ -298,10 +298,10 @@ This will never return an empty . System.ReadOnlySpan<T> - Returns the data written to the underlying buffer so far, as a . + Gets a that contains the data written to the underlying buffer so far. To be added. To be added. - \ No newline at end of file + diff --git a/xml/System.Buffers/BuffersExtensions.xml b/xml/System.Buffers/BuffersExtensions.xml index fc7d3809c0b..b1fa5856339 100644 --- a/xml/System.Buffers/BuffersExtensions.xml +++ b/xml/System.Buffers/BuffersExtensions.xml @@ -174,9 +174,9 @@ Writes the contents of to . To be added. - Thrown when the is shorter than the . + is shorter than . - \ No newline at end of file + diff --git a/xml/System.Buffers/ReadOnlySequence`1.xml b/xml/System.Buffers/ReadOnlySequence`1.xml index 8bce70219f9..7dc184ec244 100644 --- a/xml/System.Buffers/ReadOnlySequence`1.xml +++ b/xml/System.Buffers/ReadOnlySequence`1.xml @@ -255,7 +255,7 @@ The consumer is expected to manage the lifetime of memory until from the first segment. + Gets the from the first segment. To be added. To be added. @@ -819,4 +819,4 @@ The consumer is expected to manage the lifetime of memory until To be added. To be added. - Reads an as big endian. - if there wasn't enough data for an . + Reads a big-endian . + if the read operation is successful; if there isn't enough data for an . To be added. @@ -67,8 +67,8 @@ To be added. To be added. - Reads an as big endian. - if there wasn't enough data for an . + Reads a big-endian . + if the read operation is successful; if there isn't enough data for an . To be added. @@ -94,10 +94,10 @@ To be added. To be added. - Reads an as little endian. - if there wasn't enough data for an . + Reads a little-endian . + if the read operation is successful; if there isn't enough data for an . To be added. - \ No newline at end of file + diff --git a/xml/System.Buffers/SequenceReader`1.xml b/xml/System.Buffers/SequenceReader`1.xml index 5506b581d42..fc08c1e044f 100644 --- a/xml/System.Buffers/SequenceReader`1.xml +++ b/xml/System.Buffers/SequenceReader`1.xml @@ -50,8 +50,8 @@ - To be added. - Creates a over the given . + The read-only sequence over which to create the . + Creates a over a given . To be added. @@ -74,8 +74,8 @@ - To be added. - Moves the reader ahead the specified number of items. + The number of items to advance. + Moves the reader ahead a specified number of items. To be added. @@ -98,9 +98,9 @@ - To be added. + The value past which the reader is to advance. Advances past consecutive instances of the given . - How many positions the reader has been advanced. + The number of positions the reader has advanced. To be added. @@ -123,9 +123,9 @@ - To be added. - Skips consecutive instances of any of the given . - How many positions the reader has been advanced. + The values to be skipped. + Skips consecutive instances of any of the specified . + The number of positions the reader has advanced. To be added. @@ -149,10 +149,10 @@ - To be added. - To be added. - Advances past consecutive instances of any of the given values. - How many positions the reader has been advanced. + The first value to skip. + The second value to skip. + Advances past consecutive instances of either of two specified values. + The number of positions the reader has advanced. To be added. @@ -177,11 +177,11 @@ - To be added. - To be added. - To be added. - Advances past consecutive instances of any of the given values. - How many positions the reader has been advanced. + The first value to skip. + The second value to skip. + The third value to skip. + Advances past consecutive instances of any of three specified values. + The number of positions the reader has advanced. To be added. @@ -208,11 +208,11 @@ To be added. - To be added. - To be added. - To be added. - Advances past consecutive instances of any of the given values. - How many positions the reader has been advanced. + The second value to skip. + The third value to skip. + The fourth value to skip. + Advances past consecutive instances of any of four specified values. + The number of positions the reader has advanced. To be added. @@ -237,8 +237,8 @@ System.Int64 - The total number of 's processed by the reader. - To be added. + Gets the total number of values processed by the reader. + The total number of values processed by the reader. To be added. @@ -263,8 +263,8 @@ System.ReadOnlySpan<T> - The current segment in the as a span. - To be added. + Gets a that contains the current segment in the . + A span that contains the current segment in the sequence. To be added. @@ -289,8 +289,8 @@ System.Int32 - The index in the . - To be added. + Gets the index in the . + The index in the . To be added. @@ -315,8 +315,8 @@ System.Boolean - when there is no more data in the . - To be added. + Gets a value that indicates whether there is no more data in the . + when there is no more data in the ; otherwise, . To be added. @@ -340,8 +340,8 @@ The span to compare the next items to. - Move past the values if found. - Checks to see if the given values are next. + to move past the values if they are found, or to not move past them. + Checks whether the values specified in a read-only span are next in the sequence. To be added. To be added. @@ -366,8 +366,8 @@ The value to compare the next items to. - Move past the value if found. - Checks to see if the given value is next. + to move past the values if they are found, or to not move past them. + Checks whether a specified value is next in the sequence. To be added. To be added. @@ -393,8 +393,8 @@ System.Int64 - Count of in the reader's . - To be added. + Gets the count of items in the reader's . + The count of items in the reader's . To be added. @@ -419,8 +419,8 @@ System.SequencePosition - The current position in the . - To be added. + Gets the current position in the . + The current position in the . To be added. @@ -445,8 +445,8 @@ System.Int64 - Remaining 's in the reader's . - To be added. + Gets the remaining items in the reader's . + The remaining items in the reader's To be added. @@ -469,11 +469,11 @@ - To be added. + The number of items. Moves the reader back the specified number of items. To be added. - Thrown if trying to rewind a negative amount or more than . + is negative or greater than . @@ -498,8 +498,8 @@ System.Buffers.ReadOnlySequence<T> - The underlying for the reader. - To be added. + Gets the underlying for the reader. + The underlying read-only sequence for the reader. To be added. @@ -523,9 +523,9 @@ The delimiter to search for. - True to move past the if found. - Advances until the given , if found. - if the given was found. + to move past the if it is found; otherwise, . + Searches for a specified delimiter and optionally advances past it if it is found. + if the given was found; otherwise, . To be added. @@ -549,9 +549,9 @@ The delimiters to search for. - True to move past the first found instance of any of the given . - Advances until any of the given , if found. - if any of the given were found. + >see langword="true" /> to move past the first instance of any of the given ; to not move past the delimiter. + Searches for any of a number of specified delimiters and optionally advances past the first one to be found. + if any of the given was found. To be added. @@ -580,12 +580,12 @@ Destination span to copy to. - Copies data from the current to the given span if there + Copies data from the current position to the given destination span if there is enough data to fill it. - if there is enough data to completely fill the span. + if there is enough data to completely fill the span; otherwise, can be used. +This method copies a fixed amount of data out of the sequence if possible. It does not advance the reader. To look ahead for a specific stream of data, use . ]]> @@ -614,9 +614,9 @@ This API is used to copy a fixed amount of data out of the sequence if possible. - The next value or default if at the end. + The next value, or the default value if at the end of the reader. Peeks at the next value without advancing the reader. - if at the end of the reader. + if the reader is not at its end and the peek operation succeeded; if at the end of the reader. To be added. @@ -639,9 +639,9 @@ This API is used to copy a fixed amount of data out of the sequence if possible. - The next value or default if at the end. - Read the next value and advance the reader. - if at the end of the reader. + The next value, or the default value if at the end of the reader. + Reads the next value and advance the reader. + if the reader is not at its end and the read operation succeeded; if at the end of the reader. To be added. @@ -665,11 +665,11 @@ This API is used to copy a fixed amount of data out of the sequence if possible. - The read data, if any. - The multi (T) delimiter. + When the method returns, contains the data read, if any. + A read-only span that contains one or more delimiters. to move past the if found. - Tries to read data until the entire given matches. - if the was found. + Tries to read data until the entire delimiter specified as a read-only span matches. + if the was found; otherwise, . To be added. @@ -693,11 +693,11 @@ This API is used to copy a fixed amount of data out of the sequence if possible. - The read data, if any. + When the method returns, contains the data read, if any. The delimiter to look for. to move past the if found. Tries to read everything up to the given . - if the was found. + if the was found; otherwise, . To be added. @@ -721,7 +721,7 @@ This API is used to copy a fixed amount of data out of the sequence if possible. - The read data, if any. + When the method returns, contains the data read, if any. The delimiter to look for. to move past the if found. Tries to read everything up to the given . @@ -750,12 +750,12 @@ This API is used to copy a fixed amount of data out of the sequence if possible. - The read data, if any. + When the method returns, contains the data read, if any. The delimiter to look for. - If found prior to it will skip that occurrence. + A value that indicates that an immediately following is to be skipped. to move past the if found. Tries to read everything up to the given , ignoring delimiters that are preceded by . - if the was found. + if the was found; otherwise, . To be added. @@ -780,12 +780,12 @@ This API is used to copy a fixed amount of data out of the sequence if possible. - The read data, if any. + When the method returns, contains the data read, if any. The delimiter to look for. - If found prior to it will skip that occurrence. + >A value that indicates that an immediately following is to be skipped. to move past the if found. Tries to read everything up to the given , ignoring delimiters that are preceded by . - if the was found. + if the was found; otherwise, . To be added. @@ -809,11 +809,11 @@ This API is used to copy a fixed amount of data out of the sequence if possible. - The read data, if any. + When the method returns, contains the data read, if any. The delimiters to look for. to move past the first found instance of any of the given . - Tries to read everything up to the given . - if any of the were found. + Tries to read everything up to any of the specified . + if any of the were found; otherwise, . To be added. @@ -837,11 +837,11 @@ This API is used to copy a fixed amount of data out of the sequence if possible. - The read data, if any. + When the method returns, contains the data read, if any. The delimiters to look for. to move past the first found instance of any of the given . - Tries to read everything up to the given . - if any of the were found. + Tries to read everything up to any of the specified . + if any of the were found; otherwise, . To be added. @@ -866,10 +866,10 @@ This API is used to copy a fixed amount of data out of the sequence if possible. System.ReadOnlySpan<T> - The unread portion of the . + Gets the unread portion of the . To be added. To be added. - \ No newline at end of file + From ef7b0bf824f6010fe318bf7ee51e3dcbad598eae Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Tue, 9 Jul 2019 10:41:19 -0700 Subject: [PATCH 03/10] Update ArrayBufferWriter`1.xml --- xml/System.Buffers/ArrayBufferWriter`1.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/xml/System.Buffers/ArrayBufferWriter`1.xml b/xml/System.Buffers/ArrayBufferWriter`1.xml index 319ba0d19b7..e291933ada3 100644 --- a/xml/System.Buffers/ArrayBufferWriter`1.xml +++ b/xml/System.Buffers/ArrayBufferWriter`1.xml @@ -21,7 +21,7 @@ - To be added. + The type of the items in this instance. Represents a heap-based, array-backed output sink into which data can be written. To be added. @@ -193,8 +193,8 @@ You must clear the before trying to re The minimum requested length of the . - Returns a to write to that is at least the length specified by . - A whose length is at least . If is not provided or is equal to 0, some non-empty buffer is returned. + Returns a to write to that is at least the length specified by . + A whose length is at least . If is not provided or is equal to 0, some non-empty buffer is returned. . From d148d56a1e18c0f2657ee484c3d67464eb83eaa7 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Tue, 9 Jul 2019 10:42:53 -0700 Subject: [PATCH 04/10] Update ArrayBufferWriter`1.xml --- xml/System.Buffers/ArrayBufferWriter`1.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Buffers/ArrayBufferWriter`1.xml b/xml/System.Buffers/ArrayBufferWriter`1.xml index e291933ada3..1f6d8bff90e 100644 --- a/xml/System.Buffers/ArrayBufferWriter`1.xml +++ b/xml/System.Buffers/ArrayBufferWriter`1.xml @@ -93,7 +93,7 @@ Notifies the that items were written to the output / From f486ff984df2b3fdc330ddeddd1d45adca049fdf Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Tue, 9 Jul 2019 10:46:21 -0700 Subject: [PATCH 05/10] Update SequenceReader`1.xml --- xml/System.Buffers/SequenceReader`1.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Buffers/SequenceReader`1.xml b/xml/System.Buffers/SequenceReader`1.xml index fc08c1e044f..9abff1da570 100644 --- a/xml/System.Buffers/SequenceReader`1.xml +++ b/xml/System.Buffers/SequenceReader`1.xml @@ -582,7 +582,7 @@ Destination span to copy to. Copies data from the current position to the given destination span if there is enough data to fill it. - if there is enough data to completely fill the span; otherwise, + if there is enough data to completely fill the span; otherwise, . . From 2237be31f5b2e3f99c2231fb3b83c86cfd8cce29 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Tue, 9 Jul 2019 11:13:34 -0700 Subject: [PATCH 06/10] corrected bad paramref --- xml/System.Buffers/ArrayBufferWriter`1.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Buffers/ArrayBufferWriter`1.xml b/xml/System.Buffers/ArrayBufferWriter`1.xml index 1f6d8bff90e..0372e1ccd5c 100644 --- a/xml/System.Buffers/ArrayBufferWriter`1.xml +++ b/xml/System.Buffers/ArrayBufferWriter`1.xml @@ -229,7 +229,7 @@ This will never return an empty . To be added. Returns a to write to that is at least a specified length. - A span of at least in length. If is not provided or is equal to 0, some non-empty buffer is returned. + A span of at least in length. If is not provided or is equal to 0, some non-empty buffer is returned. . From fbac43c0b864f75287c1cc5588938e83967dc126 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Tue, 9 Jul 2019 11:14:59 -0700 Subject: [PATCH 07/10] Corrected bad langword tag. --- xml/System.Buffers/SequenceReader`1.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Buffers/SequenceReader`1.xml b/xml/System.Buffers/SequenceReader`1.xml index 9abff1da570..50253ef2e7e 100644 --- a/xml/System.Buffers/SequenceReader`1.xml +++ b/xml/System.Buffers/SequenceReader`1.xml @@ -616,7 +616,7 @@ This method copies a fixed amount of data out of the sequence if possible. It do The next value, or the default value if at the end of the reader. Peeks at the next value without advancing the reader. - if the reader is not at its end and the peek operation succeeded; if at the end of the reader. + if the reader is not at its end and the peek operation succeeded; if at the end of the reader. To be added. From fd1ae24b9bd7ddaf9b43dfc8ef2c03fe91bb8901 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Tue, 9 Jul 2019 13:57:49 -0700 Subject: [PATCH 08/10] Fixed bad langword tag. --- xml/System.Buffers/SequenceReader`1.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Buffers/SequenceReader`1.xml b/xml/System.Buffers/SequenceReader`1.xml index 50253ef2e7e..f5eb4d93f78 100644 --- a/xml/System.Buffers/SequenceReader`1.xml +++ b/xml/System.Buffers/SequenceReader`1.xml @@ -641,7 +641,7 @@ This method copies a fixed amount of data out of the sequence if possible. It do The next value, or the default value if at the end of the reader. Reads the next value and advance the reader. - if the reader is not at its end and the read operation succeeded; if at the end of the reader. + if the reader is not at its end and the read operation succeeded; if at the end of the reader. To be added. From 11130e82ed1b794ab96e0a84c5d8be91eb7b4214 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Tue, 9 Jul 2019 15:05:38 -0700 Subject: [PATCH 09/10] Suggestions by mairaw Co-Authored-By: Maira Wenzel Co-Authored-By: Ron Petrusha --- xml/System.Buffers/ArrayBufferWriter`1.xml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/xml/System.Buffers/ArrayBufferWriter`1.xml b/xml/System.Buffers/ArrayBufferWriter`1.xml index 0372e1ccd5c..88c2b588c77 100644 --- a/xml/System.Buffers/ArrayBufferWriter`1.xml +++ b/xml/System.Buffers/ArrayBufferWriter`1.xml @@ -94,7 +94,8 @@ + + ]]> is negative. @@ -197,7 +198,7 @@ You must clear the before trying to re A whose length is at least . If is not provided or is equal to 0, some non-empty buffer is returned. . +This method never returns . ]]> @@ -232,7 +233,7 @@ This will never return an empty . A span of at least in length. If is not provided or is equal to 0, some non-empty buffer is returned. . +This method never returns . ]]> From 14132d14e886740f7dade849139e98db4f298ffb Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Thu, 11 Jul 2019 16:32:17 -0700 Subject: [PATCH 10/10] Fixed broken link. --- xml/System.Buffers/ArrayBufferWriter`1.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Buffers/ArrayBufferWriter`1.xml b/xml/System.Buffers/ArrayBufferWriter`1.xml index 88c2b588c77..758e303e8a6 100644 --- a/xml/System.Buffers/ArrayBufferWriter`1.xml +++ b/xml/System.Buffers/ArrayBufferWriter`1.xml @@ -21,7 +21,7 @@ - The type of the items in this instance. + The type of the items in this instance. Represents a heap-based, array-backed output sink into which data can be written. To be added.