Document System.IO.Pipelines.Pipe (#3495)

* Document System.IO.Pipelines.Pipe * style guide update
dotnet · Nov 15, 2019 · a79c2dd · a79c2dd
1 parent bec01e4
commit a79c2dd
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/xml/System.IO.Pipelines/Pipe.xml b/xml/System.IO.Pipelines/Pipe.xml
@@ -16,7 +16,7 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>Default <see cref="T:System.IO.Pipelines.PipeWriter" /> and <see cref="T:System.IO.Pipelines.PipeReader" /> implementation.</summary>
+    <summary>The default <see cref="T:System.IO.Pipelines.PipeWriter" /> and <see cref="T:System.IO.Pipelines.PipeReader" /> implementation.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -35,7 +35,7 @@
       </AssemblyInfo>
       <Parameters />
       <Docs>
-        <summary>Initializes the <see cref="T:System.IO.Pipelines.Pipe" /> using <see cref="P:System.IO.Pipelines.PipeOptions.Default" /> as options.</summary>
+        <summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.Pipe" /> class using <see cref="P:System.IO.Pipelines.PipeOptions.Default" /> as options.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -57,8 +57,8 @@
         <Parameter Name="options" Type="System.IO.Pipelines.PipeOptions" />
       </Parameters>
       <Docs>
-        <param name="options">To be added.</param>
-        <summary>Initializes the <see cref="T:System.IO.Pipelines.Pipe" /> with the specified <see cref="T:System.IO.Pipelines.PipeOptions" />.</summary>
+        <param name="options">The set of options for this pipe.</param>
+        <summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.Pipe" /> class with the specified options.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -81,7 +81,7 @@
       </ReturnValue>
       <Docs>
         <summary>Gets the <see cref="T:System.IO.Pipelines.PipeReader" /> for this pipe.</summary>
-        <value>To be added.</value>
+        <value>A <see cref="T:System.IO.Pipelines.PipeReader" /> instance for this pipe.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -127,7 +127,7 @@
       </ReturnValue>
       <Docs>
         <summary>Gets the <see cref="T:System.IO.Pipelines.PipeWriter" /> for this pipe.</summary>
-        <value>To be added.</value>
+        <value>A <see cref="T:System.IO.Pipelines.PipeWriter" /> instance for this pipe.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>