Skip to content

Commit 6011578

Browse files
carlossanlopmairaw
authored andcommitted
Automatically port System.IO.Pipelines.PipeReader remarks (#3685)
1 parent 36f312b commit 6011578

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

xml/System.IO.Pipelines/PipeReader.xml

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,19 @@ The memory for the consumed data will be released and no longer available. The <
8585
<Docs>
8686
<param name="consumed">Marks the extent of the data that has been successfully processed.</param>
8787
<summary>Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed.</summary>
88-
<remarks>To be added.</remarks>
88+
<remarks>
89+
<format type="text/markdown"><![CDATA[
90+
91+
## Remarks
92+
93+
The memory for the consumed data will be released and no longer available.
94+
95+
The <xref:System.IO.Pipelines.ReadResult.Buffer> previously returned from <xref:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)> must not be accessed after this call.
96+
97+
The examined data communicates to the pipeline when it should signal more data is available.
98+
99+
]]></format>
100+
</remarks>
89101
</Docs>
90102
</Member>
91103
<Member MemberName="AdvanceTo">
@@ -114,7 +126,19 @@ The memory for the consumed data will be released and no longer available. The <
114126
<param name="consumed">Marks the extent of the data that has been successfully processed.</param>
115127
<param name="examined">Marks the extent of the data that has been read and examined.</param>
116128
<summary>Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed, read and examined.</summary>
117-
<remarks>To be added.</remarks>
129+
<remarks>
130+
<format type="text/markdown"><![CDATA[
131+
132+
## Remarks
133+
134+
The memory for the consumed data will be released and no longer available.
135+
136+
The <xref:System.IO.Pipelines.ReadResult.Buffer> previously returned from <xref:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)> must not be accessed after this call.
137+
138+
The examined data communicates to the pipeline when it should signal more data is available.
139+
140+
]]></format>
141+
</remarks>
118142
</Docs>
119143
</Member>
120144
<Member MemberName="AsStream">

0 commit comments

Comments
 (0)