Skip to content

Document System.Buffers.ReadOnlySequence #3620

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Dec 4, 2019
Merged

Document System.Buffers.ReadOnlySequence #3620

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b053cb2
Document System.Buffers.ReadOnlySequence
carlossanlop Dec 3, 2019
ab1fc6b
Document System.Buffers.ReadOnlySequenceSegment
carlossanlop Dec 3, 2019
7e54520
suggestions by mairaw
carlossanlop Dec 4, 2019
be9d664
missing dot
carlossanlop Dec 4, 2019
d6e6021
Apply suggestions from code review
carlossanlop Dec 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions xml/System.Buffers/ReadOnlySequenceSegment`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
</Base>
<Interfaces />
<Docs>
<typeparam name="T">To be added.</typeparam>
<typeparam name="T">The type of the elements in the sequence segment.</typeparam>
<summary>Represents a linked list of <see cref="T:System.ReadOnlyMemory`1" /> nodes.</summary>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -47,7 +47,7 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Initializes a new read-only sequence segment instance.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
38 changes: 24 additions & 14 deletions xml/System.Buffers/ReadOnlySequence`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
</Attribute>
</Attributes>
<Docs>
<typeparam name="T">To be added.</typeparam>
<typeparam name="T">The type of the elements in the sequence.</typeparam>
<summary>Represents a sequence that can read a sequential series of <typeparamref name="T" />.</summary>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -55,7 +55,7 @@
<Parameter Name="memory" Type="System.ReadOnlyMemory&lt;T&gt;" />
</Parameters>
<Docs>
<param name="memory">To be added.</param>
<param name="memory">A read-only block of memory of elements of type <typeparamref name="T" />.</param>
<summary>Creates an instance of <see cref="T:System.Buffers.ReadOnlySequence`1" /> from a <see cref="T:System.ReadOnlyMemory`1" />. </summary>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down Expand Up @@ -148,12 +148,22 @@ The consumer is expected to manage the lifetime of memory until <see cref="T:Sys
<Parameter Name="endIndex" Type="System.Int32" />
</Parameters>
<Docs>
<param name="startSegment">To be added.</param>
<param name="startIndex">To be added.</param>
<param name="endSegment">To be added.</param>
<param name="endIndex">To be added.</param>
<param name="startSegment">The initial node of the linked memory list.</param>
<param name="startIndex">The position to the start of the sequence inside <paramref name="startSegment" />.</param>
<param name="endSegment">The final node of the linked memory list.</param>
<param name="endIndex">The position to the end of the sequence inside <paramref name="endSegment" />.</param>
<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>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException"><paramref name="startSegment" /> or <paramref name="endSegment" /> is <see langword="null" />.</exception>
<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" />.

-or-

<paramref name="startSegment" /> is equal to <paramref name="endSegment" /> but <paramref name="endIndex" /> is smaller than <paramref name="startIndex" />.

-or-

<paramref name="startIndex" /> is greater than the length of the underlying memory block of <paramref name="startSegment" />.</exception>
</Docs>
</Member>
<Member MemberName="Empty">
Expand Down Expand Up @@ -314,9 +324,9 @@ The consumer is expected to manage the lifetime of memory until <see cref="T:Sys
<Parameter Name="offset" Type="System.Int64" />
</Parameters>
<Docs>
<param name="offset">To be added.</param>
<param name="offset">The offset from the start of the sequence.</param>
<summary>Returns a new <see cref="T:System.SequencePosition" /> at an <paramref name="offset" /> from the start of the sequence.</summary>
<returns>To be added.</returns>
<returns>An object representing the sequence position that starts at the specified <paramref name="offset" /> from the start of the sequence.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -346,10 +356,10 @@ The consumer is expected to manage the lifetime of memory until <see cref="T:Sys
<Parameter Name="origin" Type="System.SequencePosition" />
</Parameters>
<Docs>
<param name="offset">To be added.</param>
<param name="origin">To be added.</param>
<summary>Returns a new <see cref="T:System.SequencePosition" /> at an <paramref name="offset" /> from the <paramref name="origin" />.</summary>
<returns>A new object that starts at the <paramref name="offset" /> position of the original object.</returns>
<param name="offset">The offset from the specified <paramref name="origin" /> sequence position.</param>
<param name="origin">A sequence position representing the point from which to initiate the offset.</param>
<summary>Returns a new <see cref="T:System.SequencePosition" /> at an <paramref name="offset" /> from the <paramref name="origin" /> position.</summary>
<returns>An object representing the sequence position that starts at the <paramref name="offset" /> position of the specified <paramref name="origin" /> position object.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -778,8 +788,8 @@ The consumer is expected to manage the lifetime of memory until <see cref="T:Sys
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns a string that represents the current sequence.</summary>
<returns>A string that represents the current sequence.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down