8000 Document System.Buffers.ReadOnlySequence (#3620) · CAndRyan/dotnet-api-docs@00eeea0 · GitHub
[go: up one dir, main page]
Skip to content

Commit 00eeea0

Browse files
carlossanlopjozkee
carlossanlop
and
jozkee
authored
Document System.Buffers.ReadOnlySequence (dotnet#3620)
* Document System.Buffers.ReadOnlySequence * Document System.Buffers.ReadOnlySequenceSegment * suggestions by mairaw Co-Authored-By: Maira Wenzel <mairaw@microsoft.com> * missing dot * Apply suggestions from code review Co-Authored-By: David Cantu <jozkyy@gmail.com>
1 parent d8f40c0 commit 00eeea0

File tree

2 files changed

+28
-17
lines changed

2 files changed

+28
-17
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
</Base>
2424
<Interfaces />
2525
<Docs>
26-
<typeparam name="T">To be added.</typeparam>
26+
<typeparam name="T">The type of the elements in the read-only sequence segment.</typeparam>
2727
<summary>Represents a linked list of <see cref="T:System.ReadOnlyMemory`1" /> nodes.</summary>
2828
<remarks>To be added.</remarks>
2929
</Docs>
@@ -47,7 +47,7 @@
4747
</AssemblyInfo>
4848
<Parameters />
4949
<Docs>
50-
<summary>To be added.</summary>
50+
<summary>Initializes a new instance of the <see cref="T:System.Buffers.ReadOnlySequenceSegment`1" /> class.</summary>
5151
<remarks>To be added.</remarks>
5252
</Docs>
5353
</Member>

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

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
</Attribute>
2929
</Attributes>
3030
<Docs>
31-
<typeparam name="T">To be added.</typeparam>
31+
<typeparam name="T">The type of the elements in the read-only sequence.</typeparam>
3232
<summary>Represents a sequence that can read a sequential series of <typeparamref name="T" />.</summary>
3333
<remarks>To be added.</remarks>
3434
</Docs>
@@ -55,7 +55,7 @@
5555
<Parameter Name="memory" Type="System.ReadOnlyMemory&lt;T&gt;" />
5656
</Parameters>
5757
<Docs>
58-
<param name="memory">To be added.</param>
58+
<param name="memory">A read-only block of memory of elements of type <typeparamref name="T" />.</param>
5959
<summary>Creates an instance of <see cref="T:System.Buffers.ReadOnlySequence`1" /> from a <see cref="T:System.ReadOnlyMemory`1" />. </summary>
6060
<remarks>
6161
<format type="text/markdown"><![CDATA[
@@ -148,12 +148,23 @@ The consumer is expected to manage the lifetime of memory until <see cref="T:Sys
148148
<Parameter Name="endIndex" Type="System.Int32" />
149149
</Parameters>
150150
<Docs>
151-
<param name="startSegment">To be added.</param>
152-
<param name="startIndex">To be added.</param>
153-
<param name="endSegment">To be added.</param>
154-
<param name="endIndex">To be added.</param>
151+
<param name="startSegment">The initial node of the linked memory list.</param>
152+
<param name="startIndex">The position to the start of the sequence inside <paramref name="startSegment" />.</param>
153+
<param name="endSegment">The final node of the linked memory list.</param>
154+
<param name="endIndex">The position to the end of the sequence inside <paramref name="endSegment" />.</param>
155155
<summary>Creates an instance of a <see cref="T:System.Buffers.ReadOnlySequence`1" /> from a linked memory list represented by start and end segments and the corresponding indexes in them.</summary>
156156
<remarks>To be added.</remarks>
157+
<exception cref="T:System.ArgumentNullException">
158+
<paramref name="startSegment" /> or <paramref name="endSegment" /> is <see langword="null" />.</exception>
159+
<exception cref="T:System.ArgumentOutOfRangeException">The running index of <paramref name="startSegment" /> is greater than the running index of <paramref name="endSegment" />, even though <paramref name="startSegment" /> is different to <paramref name="endSegment" />.
160+
161+
-or-
162+
163+
<paramref name="startSegment" /> is equal to <paramref name="endSegment" /> but <paramref name="endIndex" /> is smaller than <paramref name="startIndex" />.
164+
165+
-or-
166+
167+
<paramref name="startIndex" /> is greater than the length of the underlying memory block of <paramref name="startSegment" />.</exception>
157168
</Docs>
158169
</Member>
159170
<Member MemberName="Empty">
@@ -178,7 +189,7 @@ The consumer is expected to manage the lifetime of memory until <see cref="T:Sys
178189
<ReturnType>System.Buffers.ReadOnlySequence&lt;T&gt;</ReturnType>
179190
</ReturnValue>
180191
<Docs>
181-
<summary>Returns an empty <see cref="T:System.Buffers.ReadOnlySequence`1" /></summary>
192+
<summary>Returns an empty <see cref="T:System.Buffers.ReadOnlySequence`1" />.</summary>
182193
<remarks>To be added.</remarks>
183194
</Docs>
184195
</Member>
@@ -314,9 +325,9 @@ The consumer is expected to manage the lifetime of memory until <see cref="T:Sys
314325
<Parameter Name="offset" Type="System.Int64" />
315326
</Parameters>
316327
<Docs>
317-
<param name="offset">To be added.</param>
328+
<param name="offset">The offset from the start of the sequence.</param>
318329
<summary>Returns a new <see cref="T:System.SequencePosition" /> at an <paramref name="offset" /> from the start of the sequence.</summary>
319-
<returns>To be added.</returns>
330+
<returns>An object representing the sequence position that starts at the specified <paramref name="offset" /> from the start of the sequence.</returns>
320331
<remarks>To be added.</remarks>
321332
</Docs>
322333
</Member>
@@ -346,10 +357,10 @@ The consumer is expected to manage the lifetime of memory until <see cref="T:Sys
346357
<Parameter Name="origin" Type="System.SequencePosition" />
347358
</Parameters>
348359
<Docs>
349-
<param name="offset">To be added.</param>
350-
<param name="origin">To be added.</param>
351-
<summary>Returns a new <see cref="T:System.SequencePosition" /> at an <paramref name="offset" /> from the <paramref name="origin" />.</summary>
352-
<returns>A new object that starts at the <paramref name="offset" /> position of the original object.</returns>
360+
<param name="offset">The offset from the specified <paramref name="origin" /> sequence position.</param>
361+
<param name="origin">A sequence position representing the point from which to initiate the offset.</param>
362+
<summary>Returns a new <see cref="T:System.SequencePosition" /> starting at the specified offset from the <paramref name="origin" /> position.</summary>
363+
<returns>An object representing the sequence position that starts at the <paramref name="offset" /> position of the specified <paramref name="origin" /> position object.</returns>
353364
<remarks>To be added.</remarks>
354365
</Docs>
355366
</Member>
@@ -778,8 +789,8 @@ The consumer is expected to manage the lifetime of memory until <see cref="T:Sys
778789
</ReturnValue>
779790
<Parameters />
780791
<Docs>
781-
<summary>To be added.</summary>
782-
<returns>To be added.</returns>
792+
<summary>Returns a string that represents the current sequence.</summary>
793+
<returns>A string that represents the current sequence.</returns>
783794
<remarks>To be added.</remarks>
784795
<inheritdoc />
785796
</Docs>

0 commit comments

Comments
 (0)
0