Skip to content

Commit 13afe2c

Browse files
carlossanlopBillWagner
authored andcommitted
Fix GZipStream.Flush summary and remarks (#3789)
1 parent e2e9976 commit 13afe2c

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

xml/System.IO.Compression/GZipStream.xml

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -980,16 +980,17 @@ Calling `DisposeAsync` allows the resources used by the <xref:System.IO.Compress
980980
</ReturnValue>
981981
<Parameters />
982982
<Docs>
983-
<summary>The current implementation of this method has no functionality.</summary>
983+
<summary>Flushes the internal buffers.</summary>
984984
<remarks>
985-
<format type="text/markdown"><![CDATA[
986-
987-
## Remarks
988-
The current implementation of this method does not flush the internal buffer. The internal buffer is flushed when the object is disposed.
989-
990-
]]></format>
985+
<format type="text/markdown"><![CDATA[
986+
987+
## Remarks
988+
989+
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.
990+
991+
]]></format>
991992
</remarks>
992-
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
993+
<exception cref="T:System.ObjectDisposedException">The underlying stream is closed.</exception>
993994
</Docs>
994995
</Member>
995996
<Member MemberName="FlushAsync">

0 commit comments

Comments
 (0)