Skip to content

Commit 87c3b84

Browse files
carlossanlopRon Petrusha
carlossanlop
authored and
Ron Petrusha
committed
Document System.Buffers.SequenceReader (#2841)
* Document System.Buffers.SequenceReader * Update SequenceReaderExtensions.xml * malformed cref to ReadOnlySequence * Update SequenceReaderExtensions.xml * suggestions by rpetrusha and ahsonkhan Co-Authored-By: Ahson Khan <[email protected]> * suggestion by rpetrusha
1 parent 72af7a5 commit 87c3b84

File tree

3 files changed

+34
-38
lines changed

3 files changed

+34
-38
lines changed

‎xml/System.Buffers/ArrayBufferWriter`1.xml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -227,9 +227,8 @@ This method never returns <xref:System.Memory%601.Empty?displayProperty=nameWith
227227
<Parameter Name="sizeHint" Type="System.Int32" />
228228
</Parameters>
229229
<Docs>
230-
<param name="sizeHint">To be added.</param>
231-
<summary>Returns a <see cref="T:System.Span`1" /> to write to that is at least a specified length.
232-
</summary>
230+
<param name="sizeHint">The minimum requested length of the <see cref="T:System.Span`1" />.</param>
231+
<summary>Returns a <see cref="T:System.Span`1" /> to write to that is at least a specified length.</summary>
233232
<returns>A span of at least <paramref name="sizeHint" /> in length. If <paramref name="sizeHint" /> is not provided or is equal to 0, some non-empty buffer is returned.</returns>
234233
<remarks>
235234
<format type="text/markdown"><![CDATA[
@@ -300,9 +299,9 @@ This method never returns <xref:System.Memory%601.Empty?displayProperty=nameWith
300299
</ReturnValue>
301300
<Docs>
302301
<summary>Gets a <see cref="T:System.ReadOnlySpan`1" /> that contains the data written to the underlying buffer so far.</summary>
303-
<value>To be added.</value>
302+
<value>The data written to the underlying buffer.</value>
304303
<remarks>To be added.</remarks>
305304
</Docs>
306305
</Member>
307306
</Members>
308-
</Type>
307+
</Type>

‎xml/System.Buffers/SequenceReaderExtensions.xml

Lines changed: 26 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>To be added.</summary>
17+
<summary>Provides extended functionality for the <see cref="T:System.Buffers.SequenceReader`1" /> class that allows reading of endian specific numeric values from binary data.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>
@@ -38,10 +38,10 @@
3838
<Parameter Name="value" Type="System.Int16" RefType="out" />
3939
</Parameters>
4040
<Docs>
41-
<param name="reader">To be added.</param>
42-
<param name="value">To be added.</param>
43-
<summary>To be added.</summary>
44-
<returns>To be added.</returns>
41+
<param name="reader">The byte sequence reader instance from which the value is to be read.</param>
42+
<param name="value">When the method returns, the value read out of the byte sequence reader, as big endian.</param>
43+
<summary>Tries to read an <see cref="System.Int16" /> as big endian.</summary>
44+
<returns><see langword="true" /> if the read operation is successful; <see langword="false" /> if there isn't enough data for an <see cref="T:System.Int16" />.</returns>
4545
<remarks>To be added.</remarks>
4646
</Docs>
4747
</Member>
@@ -65,10 +65,10 @@
6565
<Parameter Name="value" Type="System.Int32" RefType="out" />
6666
</Parameters>
6767
<Docs>
68-
<param name="reader">To be added.</param>
69-
<param name="value">To be added.</param>
70-
<summary>To be added.</summary>
71-
<returns>To be added.</returns>
68+
<param name="reader">The byte sequence reader from which to read the value.</param>
69+
<param name="value">When the method returns, the value read out of the byte sequence reader, as big endian.</param>
70+
<summary>Tries to read an <see cref="System.Int32" /> as big endian.</summary>
71+
<returns><see langword="true" /> if the read operation is successful; <see langword="false" /> if there isn't enough data for an <see cref="T:System.Int32" />.</returns>
7272
<remarks>To be added.</remarks>
7373
</Docs>
7474
</Member>
@@ -92,11 +92,10 @@
9292
<Parameter Name="value" Type="System.Int64" RefType="out" />
9393
</Parameters>
9494
<Docs>
95-
<param name="reader">To be added.</param>
96-
<param name="value">To be added.</param>
97-
<summary>Reads a big-endian <see cref="T:System.Int16" />.</summary>
98-
<returns>
99-
<see langword="true" /> if the read operation is successful; <see langword="false" /> if there isn't enough data for an <see cref="T:System.Int16" />.</returns>
95+
<param name="reader">The byte sequence reader instance from which the value is to be read.</param>
96+
<param name="value">When the method returns, the value read out of the byte sequence reader, as big endian.</param>
97+
<summary>Tries to read an <see cref="System.Int64" /> as big endian.</summary>
98+
<returns><see langword="true" /> if the read operation is successful; <see langword="false" /> if there isn't enough data for an <see cref="T:System.Int64" />.</returns>
10099
<remarks>To be added.</remarks>
101100
</Docs>
102101
</Member>
@@ -120,10 +119,10 @@
120119
<Parameter Name="value" Type="System.Int16" RefType="out" />
121120
</Parameters>
122121
<Docs>
123-
<param name="reader">To be added.</param>
124-
<param name="value">To be added.</param>
125-
<summary>To be added.</summary>
126-
<returns>To be added.</returns>
122+
<param name="reader">The byte sequence reader instance from which the value is to be read.</param>
123+
<param name="value">When the method returns, the value read out of the byte sequence reader, as little endian.</param>
124+
<summary>Tries to read an <see cref="System.Int16" /> as little endian.</summary>
125+
<returns><see langword="true" /> if the read operation is successful; <see langword="false" /> if there isn't enough data for an <see cref="T:System.Int16" />.</returns>
127126
<remarks>To be added.</remarks>
128127
</Docs>
129128
</Member>
@@ -147,11 +146,10 @@
147146
<Parameter Name="value" Type="System.Int32" RefType="out" />
148147
</Parameters>
149148
<Docs>
150-
<param name="reader">To be added.</param>
151-
<param name="value">To be added.</param>
152-
<summary>Reads a big-endian <see cref="T:System.Int32" />.</summary>
153-
<returns>
154-
<see langword="true" /> if the read operation is successful; <see langword="false" /> if there isn't enough data for an <see cref="T:System.Int32" />.</returns>
149+
<param name="reader">The byte sequence reader instance from which the value is to be read.</param>
150+
<param name="value">When the method returns, the value read out of the byte sequence reader, as little endian.</param>
151+
<summary>Tries to read an <see cref="System.Int32" /> as little endian.</summary>
152+
<returns><see langword="true" /> if the read operation is successful; <see langword="false" /> if there isn't enough data for an <see cref="T:System.Int32" />.</returns>
155153
<remarks>To be added.</remarks>
156154
</Docs>
157155
</Member>
@@ -175,13 +173,12 @@
175173
<Parameter Name="value" Type="System.Int64" RefType="out" />
176174
</Parameters>
177175
<Docs>
178-
<param name="reader">To be added.</param>
179-
<param name="value">To be added.</param>
180-
<summary>Reads a little-endian <see cref="T:System.Int16" />.</summary>
181-
<returns>
182-
<see langword="true" /> if the read operation is successful; <see langword="false" /> if there isn't enough data for an <see cref="T:System.Int16" />.</returns>
176+
<param name="reader">The byte sequence reader instance from which the value is to be read.</param>
177+
<param name="value">When the method returns, the value read out of the byte sequence reader, as little endian.</param>
178+
<summary>Tries to read an <see cref="System.Int64" /> as little endian.</summary>
179+
<returns><see langword="true" /> if the read operation is successful; <see langword="false" /> if there isn't enough data for an <see cref="T:System.Int64" />.</returns>
183180
<remarks>To be added.</remarks>
184181
</Docs>
185182
</Member>
186183
</Members>
187-
</Type>
184+
</Type>

‎xml/System.Buffers/SequenceReader`1.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@
2929
</Attribute>
3030
</Attributes>
3131
<Docs>
32-
<typeparam name="T">To be added.</typeparam>
33-
<summary>To be added.</summary>
32+
<typeparam name="T">The type of the read-only sequence.</typeparam>
33+
<summary>Provides methods for reading binary and text data out of a <see cref="T:System.Buffers.ReadOnlySequence`1" /> with a focus on performance and minimal or zero heap allocations.</summary>
3434
<remarks>To be added.</remarks>
3535
</Docs>
3636
<Members>
@@ -207,7 +207,7 @@
207207
<Parameter Name="value3" Type="T" />
208208
</Parameters>
209209
<Docs>
210-
<param name="value0">To be added.</param>
210+
<param name="value0">The first value to skip.</param>
211211
<param name="value1">The second value to skip.</param>
212212
<param name="value2">The third value to skip.</param>
213213
<param name="value3">The fourth value to skip.</param>
@@ -898,4 +898,4 @@ This method copies a fixed amount of data out of the sequence if possible. It do
898898
</Docs>
899899
</Member>
900900
</Members>
901-
</Type>
901+
</Type>

0 commit comments

Comments
 (0)