Skip to content

Commit a79c2dd

Browse files
authored
Document System.IO.Pipelines.Pipe (#3495)
* Document System.IO.Pipelines.Pipe * style guide update
1 parent bec01e4 commit a79c2dd

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

xml/System.IO.Pipelines/Pipe.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
</Base>
1717
<Interfaces />
1818
<Docs>
19-
<summary>Default <see cref="T:System.IO.Pipelines.PipeWriter" /> and <see cref="T:System.IO.Pipelines.PipeReader" /> implementation.</summary>
19+
<summary>The default <see cref="T:System.IO.Pipelines.PipeWriter" /> and <see cref="T:System.IO.Pipelines.PipeReader" /> implementation.</summary>
2020
<remarks>To be added.</remarks>
2121
</Docs>
2222
<Members>
@@ -35,7 +35,7 @@
3535
</AssemblyInfo>
3636
<Parameters />
3737
<Docs>
38-
<summary>Initializes the <see cref="T:System.IO.Pipelines.Pipe" /> using <see cref="P:System.IO.Pipelines.PipeOptions.Default" /> as options.</summary>
38+
<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>
3939
<remarks>To be added.</remarks>
4040
</Docs>
4141
</Member>
@@ -57,8 +57,8 @@
5757
<Parameter Name="options" Type="System.IO.Pipelines.PipeOptions" />
5858
</Parameters>
5959
<Docs>
60-
<param name="options">To be added.</param>
61-
<summary>Initializes the <see cref="T:System.IO.Pipelines.Pipe" /> with the specified <see cref="T:System.IO.Pipelines.PipeOptions" />.</summary>
60+
<param name="options">The set of options for this pipe.</param>
61+
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.Pipe" /> class with the specified options.</summary>
6262
<remarks>To be added.</remarks>
6363
</Docs>
6464
</Member>
@@ -81,7 +81,7 @@
8181
</ReturnValue>
8282
<Docs>
8383
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeReader" /> for this pipe.</summary>
84-
<value>To be added.</value>
84+
<value>A <see cref="T:System.IO.Pipelines.PipeReader" /> instance for this pipe.</value>
8585
<remarks>To be added.</remarks>
8686
</Docs>
8787
</Member>
@@ -127,7 +127,7 @@
127127
</ReturnValue>
128128
<Docs>
129129
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeWriter" /> for this pipe.</summary>
130-
<value>To be added.</value>
130+
<value>A <see cref="T:System.IO.Pipelines.PipeWriter" /> instance for this pipe.</value>
131131
<remarks>To be added.</remarks>
132132
</Docs>
133133
</Member>

0 commit comments

Comments
 (0)