Skip to content

Fix GZipStream.Flush summary and remarks #3789

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 1 commit into from
Jan 22, 2020
Merged

Fix GZipStream.Flush summary and remarks #3789

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 9 additions & 8 deletions xml/System.IO.Compression/GZipStream.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -980,16 +980,17 @@ Calling `DisposeAsync` allows the resources used by the <xref:System.IO.Compress
</ReturnValue>
<Parameters />
<Docs>
<summary>The current implementation of this method has no functionality.</summary>
<summary>Flushes the internal buffers.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
The current implementation of this method does not flush the internal buffer. The internal buffer is flushed when the object is disposed.

]]></format>
<format type="text/markdown"><![CDATA[

## Remarks

This method flushes only if the current compression mode is <xref:System.IO.Compression.CompressionMode.Compress> and the underlying stream still has some input left to write.

]]></format>
</remarks>
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
<exception cref="T:System.ObjectDisposedException">The underlying stream is closed.</exception>
</Docs>
</Member>
<Member MemberName="FlushAsync">
Expand Down