Document System.IO.Pipelines.ReadResult (#3491)

* Document System.IO.Pipelines.ReadResult

* Update xml/System.IO.Pipelines/ReadResult.xml

* suggestions by halter73

Co-Authored-By: Stephen Halter <[email protected]>

* fix build failure

* suggestion by tdykstra

Co-Authored-By: Tom Dykstra <[email protected]>

Author: carlossanlop

xml/System.IO.Pipelines/ReadResult.xml

@@ -16,7 +16,7 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>The result of a <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> call.</summary>
+    <summary>Represents the result of a <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> call.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -40,9 +40,9 @@
         <Parameter Name="isCompleted" Type="System.Boolean" />
       </Parameters>
       <Docs>
-        <param name="buffer">To be added.</param>
-        <param name="isCanceled">To be added.</param>
-        <param name="isCompleted">To be added.</param>
+        <param name="buffer">The read-only sequence containing the bytes of data that were read in the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> call.</param>
+        <param name="isCanceled">A flag that indicates if the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation that produced this <see cref="T:System.IO.Pipelines.ReadResult" /> was canceled by <see cref="M:System.IO.Pipelines.PipeReader.CancelPendingRead()" />.</param>
+        <param name="isCompleted">A flag that indicates whether the end of the data stream has been reached.</param>
         <summary>Creates a new instance of <see cref="T:System.IO.Pipelines.ReadResult" /> setting <see cref="P:System.IO.Pipelines.ReadResult.IsCanceled" /> and <see cref="P:System.IO.Pipelines.ReadResult.IsCompleted" /> flags.</summary>
         <remarks>To be added.</remarks>
       </Docs>
@@ -66,7 +66,7 @@
       </ReturnValue>
       <Docs>
         <summary>Gets the <see cref="T:System.Buffers.ReadOnlySequence`1" /> that was read.</summary>
-        <value>To be added.</value>
+        <value>A read-only sequence containing the bytes of data that were read in the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> call.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -88,9 +88,8 @@
         <ReturnType>System.Boolean</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>
-          <see langword="true" /> if the current <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation was canceled; otherwise, <see langword="false" />.</summary>
-        <value>To be added.</value>
+        <summary>Gets a value that indicates whether the current <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation was canceled.</summary>
+        <value><see langword="true" /> if the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation that produced this <see cref="T:System.IO.Pipelines.ReadResult" /> was canceled by <see cref="M:System.IO.Pipelines.PipeReader.CancelPendingRead()" />; otherwise, <see langword="false" />.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -112,9 +111,8 @@
         <ReturnType>System.Boolean</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>
-          <see langword="true" /> if the <see cref="T:System.IO.Pipelines.PipeReader" /> is complete; otherwise, <see langword="false" />.</summary>
-        <value>To be added.</value>
+        <summary>Gets a value that indicates whether the end of the data stream has been reached.</summary>
+        <value><see langword="true" /> if the end of the data stream has been reached; otherwise, <see langword="false" />.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>