Skip to content

Port System.IO.Compression docs from RC1 #10485

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 2 commits into from
Oct 4, 2024
Merged

Port System.IO.Compression docs from RC1 #10485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc67ff7
Port System.IO.Compression docs from RC1
carlossanlop Oct 1, 2024
81daf02
Apply suggestions from code review
carlossanlop Oct 4, 2024
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
9 changes: 5 additions & 4 deletions xml/System.IO.Compression/BrotliCompressionOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Provides compression options to be used with <see cref="T:System.IO.Compression.BrotliStream" />.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -51,9 +51,10 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets or sets the compression quality for a Brotli compression stream.</summary>
<value>The compression quality for a Brotli compression stream. The default value is 4.</value>
<remarks>The higher the quality, the slower the compression. The range is from 0 to 11.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">The value is less than 0 or greater than 11.</exception>
</Docs>
</Member>
</Members>
Expand Down
15 changes: 11 additions & 4 deletions xml/System.IO.Compression/BrotliStream.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@
<summary>Initializes a new instance of the <see cref="T:System.IO.Compression.BrotliStream" /> class by using the specified stream and compression level.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">.NET 7 and later: <paramref name="compressionLevel" /> is not defined in the <see cref="System.IO.Compression.CompressionLevel" /> enumeration.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="stream" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down Expand Up @@ -132,11 +134,14 @@
<Parameter Name="leaveOpen" Type="System.Boolean" Index="2" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<param name="stream">To be added.</param>
<param name="compressionOptions">To be added.</param>
<param name="leaveOpen">To be added.</param>
<summary>To be added.</summary>
<param name="stream">The stream to which compressed data is written.</param>
<param name="compressionOptions">The Brotli options for fine tuning the compression stream.</param>
<param name="leaveOpen">
<see langword="true" /> to leave the stream open after disposing the <see cref="T:System.IO.Compression.BrotliStream" /> object; otherwise, <see langword="false" />.</param>
<summary>Initializes a new instance of the <see cref="T:System.IO.Compression.BrotliStream" /> class by using the specified stream and compression options, and optionally leaves the stream open.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="stream" /> or <paramref name="compressionOptions" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down Expand Up @@ -174,6 +179,8 @@
<summary>Initializes a new instance of the <see cref="T:System.IO.Compression.BrotliStream" /> class by using the specified stream and compression level, and optionally leaves the stream open.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">.NET 7 and later: <paramref name="compressionLevel" /> is not defined in the <see cref="System.IO.Compression.CompressionLevel" /> enumeration.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="stream" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down
11 changes: 7 additions & 4 deletions xml/System.IO.Compression/DeflateStream.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,11 +362,14 @@ You use this constructor when you want to specify whether compression efficiency
<Parameter Name="leaveOpen" Type="System.Boolean" Index="2" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<param name="stream">To be added.</param>
<param name="compressionOptions">To be added.</param>
<param name="leaveOpen">To be added.</param>
<summary>To be added.</summary>
<param name="stream">The stream to which compressed data is written.</param>
<param name="compressionOptions">The options for fine tuning the compression stream.</param>
<param name="leaveOpen">
<see langword="true" /> to leave the stream object open after disposing the <see cref="T:System.IO.Compression.DeflateStream" /> object; otherwise, <see langword="false" /></param>
<summary>Initializes a new instance of the <see cref="T:System.IO.Compression.DeflateStream" /> class by using the specified stream, compression options, and optionally leaves the stream open.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="stream" /> or <paramref name="compressionOptions" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="BaseStream">
Expand Down
11 changes: 7 additions & 4 deletions xml/System.IO.Compression/GZipStream.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,11 +387,14 @@ By default, the compression level is set to <xref:System.IO.Compression.Compress
<Parameter Name="leaveOpen" Type="System.Boolean" Index="2" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<param name="stream">To be added.</param>
<param name="compressionOptions">To be added.</param>
<param name="leaveOpen">To be added.</param>
<summary>To be added.</summary>
<param name="stream">The stream to which compressed data is written.</param>
<param name="compressionOptions">The options for fine tuning the compression stream.</param>
<param name="leaveOpen">
<see langword="true" /> to leave the stream object open after disposing the <see cref="T:System.IO.Compression.GZipStream" /> object; otherwise, <see langword="false" />.</param>
<summary>Initializes a new instance of the <see cref="T:System.IO.Compression.GZipStream" /> class by using the specified stream, compression options, and optionally leaves the stream open.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="stream" /> or <paramref name="compressionOptions" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="BaseStream">
Expand Down
15 changes: 10 additions & 5 deletions xml/System.IO.Compression/ZLibCompressionOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Provides compression options to be used with <see cref="T:System.IO.Compression.ZLibStream" />, <see cref="T:System.IO.Compression.DeflateStream" />, and <see cref="T:System.IO.Compression.GZipStream" />.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -51,9 +51,13 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets or sets the compression level for a compression stream.</summary>
<value>The compression level for a compression stream. The default value is -1.</value>
<remarks>
<para>Can accept any value between -1 and 9 (inclusive). 0 gives no compression, 1 gives best speed, 9 gives best compression,</para>
<para>and -1 requests the default compression level, which is equivalent to 6.</para>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">The value is less than -1 or greater than 9.</exception>
</Docs>
</Member>
<Member MemberName="CompressionStrategy">
Expand All @@ -72,9 +76,10 @@
<ReturnType>System.IO.Compression.ZLibCompressionStrategy</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets the compression algorithm for a compression stream.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">The value is not a valid <see cref="T:System.IO.Compression.ZLibCompressionStrategy" /> value.</exception>
</Docs>
</Member>
</Members>
Expand Down
14 changes: 8 additions & 6 deletions xml/System.IO.Compression/ZLibCompressionStrategy.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<summary>Defines the compression algorithms that can be used for <see cref="T:System.IO.Compression.DeflateStream" />, <see cref="T:System.IO.Compression.GZipStream" />, and <see cref="T:System.IO.Compression.ZLibStream" />.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -34,7 +34,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Used for normal data.</summary>
</Docs>
</Member>
<Member MemberName="Filtered">
Expand All @@ -54,7 +54,9 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>
<para>Used for data produced by a filter (or predictor). The effect of Filtered is to force more Huffman coding and less string matching; it's an intermediate between Default and HuffmanOnly.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Fixed">
Expand All @@ -74,7 +76,7 @@
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Prevents the use of dynamic Huffman codes, allowing for a simpler decoder for special applications.</summary>
</Docs>
</Member>
<Member MemberName="HuffmanOnly">
Expand All @@ -94,7 +96,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Used to force Huffman encoding only (no string match).</summary>
</Docs>
</Member>
<Member MemberName="RunLengthEncoding">
Expand All @@ -114,7 +116,7 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Used to limit match distances to one (run-length encoding). Gives better compression for PNG image data.</summary>
</Docs>
</Member>
</Members>
Expand Down
11 changes: 7 additions & 4 deletions xml/System.IO.Compression/ZLibStream.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,11 +158,14 @@
<Parameter Name="leaveOpen" Type="System.Boolean" Index="2" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<param name="stream">To be added.</param>
<param name="compressionOptions">To be added.</param>
<param name="leaveOpen">To be added.</param>
<summary>To be added.</summary>
<param name="stream">The stream to which compressed data is written.</param>
<param name="compressionOptions">The ZLib options for fine tuning the compression stream.</param>
<param name="leaveOpen">
<see langword="true" /> to leave the stream object open after disposing the <see cref="T:System.IO.Compression.ZLibStream" /> object; otherwise, <see langword="false" />.</param>
<summary>Initializes a new instance of the <see cref="T:System.IO.Compression.ZLibStream" /> class by using the specified stream and compression options, and optionally leaves the stream open.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="stream" /> or <paramref name="compressionOptions" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="BaseStream">
Expand Down