Skip to content

Port System.IO.Pipelines source code comments to Docs #2304

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Apr 26, 2019
Merged

Port System.IO.Pipelines source code comments to Docs #2304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
395da63
Port System.IO.Pipelines source code comments to Docs
carlossanlop Apr 15, 2019
06a7f1d
Update xml/System.IO.Pipelines/PipeReader.xml
Apr 16, 2019
ebc6039
Update xml/System.IO.Pipelines/PipeReader.xml
Apr 16, 2019
a93d8cc
Update xml/System.IO.Pipelines/StreamPipeExtensions.xml
Apr 16, 2019
ecf2596
Added missing comments suggested by rpetrusha in PR.
carlossanlop Apr 18, 2019
4b6a5b2
Merge branch 'pipelines' of https://github.com/carlossanlop/dotnet-ap…
carlossanlop Apr 18, 2019
9541746
close tag
mairaw Apr 23, 2019
bbfe174
Update PipeWriter.xml
Apr 25, 2019
3d46865
Update PipeWriter.xml
Apr 25, 2019
9507a5a
Apply suggestions from code review
carlossanlop Apr 26, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions xml/System.IO.Pipelines/PipeReader.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.PipeReader" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -113,8 +113,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns a read-only <see cref="T:System.IO.Stream" /> that wraps the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<returns>The stream that wraps the <see cref="T:System.IO.Pipelines.PipeReader" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -183,10 +183,10 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="dotnet-plat-ext-3.0" />
</Parameters>
<Docs>
<param name="destination">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="destination">The stream to which the contents of the current stream will be copied.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Pipelines.PipeReader" /> and writes them to the specified stream, using a specified cancellation token.</summary>
<returns>A task that represents the asynchronous copy operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -272,4 +272,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>
58 changes: 40 additions & 18 deletions xml/System.IO.Pipelines/PipeWriter.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Initializes a new instance of the class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -67,8 +67,8 @@
<Parameter Name="bytes" Type="System.Int32" />
</Parameters>
<Docs>
<param name="bytes">To be added.</param>
<summary>To be added.</summary>
<param name="bytes">The number of bytes written to the <see cref="T:System.Span`1" /> or <see cref="T:System.Memory`1" />.</param>
<summary>Notifies the <see cref="T:System.IO.Pipelines.PipeWriter" /> that <paramref name="bytes" /> bytes were written to the output <see cref="T:System.Span`1" /> or <see cref="T:System.Memory`1" />. You must request a new buffer after calling <see cref="M:System.IO.Pipelines.PipeWriter.Advance(System.Int32)" /> to continue writing more data; you cannot write to a previously acquired buffer.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand All @@ -90,8 +90,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns a write-only <see cref="T:System.IO.Stream" /> that wraps the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
<returns>The <see cref="T:System.IO.Stream" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -160,10 +160,10 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="dotnet-plat-ext-3.0" />
</Parameters>
<Docs>
<param name="source">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="source">The stream from which the contents will be copied.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<summary>Asynchronously reads the bytes from the specified stream and writes them to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
<returns>A task that represents the asynchronous copy operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -215,10 +215,21 @@
<Parameter Name="sizeHint" Type="System.Int32" />
</Parameters>
<Docs>
<param name="sizeHint">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="sizeHint">The minimum length of the returned <see cref="T:System.Memory`1" />. If 0, a non-empty memory buffer of arbitrary size is returned.</param>
<summary>Returns a <see cref="T:System.Memory`1" /> to write to that is at least the requested size, as specified by the <paramref name="sizeHint" /> parameter.</summary>
<returns>A memory buffer of at least <paramref name="sizeHint" /> bytes. If <paramref name="sizeHint" /> is 0, returns a non-empty buffer of arbitrary size.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

There is no guarantee that successive calls will return the same buffer or the same-sized buffer.

This method never returns <xref:System.Memory`1.Empty?displayProperty=nameWithType>, but it throws an <xref:System.OutOfMemoryException> if the requested buffer size is not available.

You must request a new buffer after calling <xref:System.IO.Pipelines.PipeWriter.Advance%2A> to continue writing more data; you cannot write to a previously acquired buffer.

]]></format>
</remarks>
<exception cref="T:System.OutOfMemoryException">The requested buffer size is not available.</exception>
<inheritdoc />
</Docs>
</Member>
Expand All @@ -245,10 +256,21 @@
<Parameter Name="sizeHint" Type="System.Int32" />
</Parameters>
<Docs>
<param name="sizeHint">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="sizeHint">The minimum length of the returned <see cref="T:System.Span`1" />. If 0, a non-empty buffer of arbitrary size is returned.</param>
<summary>Returns a <see cref="T:System.Span`1" /> to write to that is at least the requested size, as specified by the <paramref name="sizeHint" /> parameter.</summary>
<returns>A buffer of at least <paramref name="sizeHint" /> bytes. If <paramref name="sizeHint" /> is 0, returns a non-empty buffer of arbitrary size.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

There is no guarantee that successive calls will return the same buffer or the same-sized buffer.

This method never returns <see cref="P:System.Span`1.Empty" />, but it throws an <see cref="T:System.OutOfMemoryException" /> if the requested buffer size is not available.

You must request a new buffer after calling <xref:System.IO.Pipelines.PipeWriter.Advance(System.Int32)> to continue writing more data; you cannot write to a previously acquired buffer.

]]></format>
</remarks>
<exception cref="T:System.OutOfMemoryException">The requested buffer size is not available.</exception>
<inheritdoc />
</Docs>
</Member>
Expand Down Expand Up @@ -308,4 +330,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>
12 changes: 6 additions & 6 deletions xml/System.IO.Pipelines/StreamPipeExtensions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,13 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="source">To be added.</param>
<param name="destination">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="source">The stream from which the contents of the current stream will be copied.</param>
<param name="destination">The writer to which the contents of the source stream will be copied.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Stream" /> and writes them to the specified <see cref="T:System.IO.Pipelines.PipeWriter" />, using a cancellation token.</summary>
<returns>A task that represents the asynchronous copy operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>