Skip to content

Commit 970499a

Browse files
carlossanlopRon Petrusha
authored andcommitted
Automatic port of System.IO.Pipelines PipeReader/PipeWriter CompleteAsync (dotnet#3007)
* Document System.IO.Pipelines PipeReader/PipeWriter CompleteAsync * that's -> that is * Minor updates. * Minor changes. * Update PipeReader.xml
1 parent eaf79ba commit 970499a

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

xml/System.IO.Pipelines/PipeReader.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="PipeReader" FullName="System.IO.Pipelines.PipeReader">
1+
<Type Name="PipeReader" FullName="System.IO.Pipelines.PipeReader">
22
<TypeSignature Language="C#" Value="public abstract class PipeReader" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit PipeReader extends System.Object" />
44
<TypeSignature Language="DocId" Value="T:System.IO.Pipelines.PipeReader" />
@@ -184,9 +184,9 @@
184184
<Parameter Name="exception" Type="System.Exception" Index="0" FrameworkAlternate="dotnet-plat-ext-3.0" />
185185
</Parameters>
186186
<Docs>
187-
<param name="exception">To be added.</param>
188-
<summary>To be added.</summary>
189-
<returns>To be added.</returns>
187+
<param name="exception">An optional exception that indicates the failure that caused the reader to complete.</param>
188+
<summary>Marks the current pipe reader instance as being complete, meaning no more data will be read from it.</summary>
189+
<returns>A value task that represents the asynchronous complete operation.</returns>
190190
<remarks>To be added.</remarks>
191191
</Docs>
192192
</Member>

xml/System.IO.Pipelines/PipeWriter.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="PipeWriter" FullName="System.IO.Pipelines.PipeWriter">
1+
<Type Name="PipeWriter" FullName="System.IO.Pipelines.PipeWriter">
22
<TypeSignature Language="C#" Value="public abstract class PipeWriter : System.Buffers.IBufferWriter&lt;byte&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit PipeWriter extends System.Object implements class System.Buffers.IBufferWriter`1&lt;unsigned int8&gt;" />
44
<TypeSignature Language="DocId" Value="T:System.IO.Pipelines.PipeWriter" />
@@ -161,9 +161,9 @@
161161
<Parameter Name="exception" Type="System.Exception" Index="0" FrameworkAlternate="dotnet-plat-ext-3.0" />
162162
</Parameters>
163163
<Docs>
164-
<param name="exception">To be added.</param>
165-
<summary>To be added.</summary>
166-
<returns>To be added.</returns>
164+
<param name="exception">An optional exception that indicates the failure that caused the pipeline to complete.</param>
165+
<summary>Marks the current pipe writer instance as being complete, meaning no more data will be written to it.</summary>
166+
<returns>A value task that represents the asynchronous complete operation.</returns>
167167
<remarks>To be added.</remarks>
168168
</Docs>
169169
</Member>

0 commit comments

Comments
 (0)