System.IO.Compression docs

Author: ericstj

xml/System.IO.Compression/ZipArchive.xml

@@ -384,14 +384,30 @@ If the comment byte length is larger than <xref:System.UInt16.MaxValue>, it will
         <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="4" FrameworkAlternate="net-10.0" />
       </Parameters>
       <Docs>
-        <param name="stream">To be added.</param>
-        <param name="mode">To be added.</param>
-        <param name="leaveOpen">To be added.</param>
-        <param name="entryNameEncoding">To be added.</param>
-        <param name="cancellationToken">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="stream">The input or output stream.</param>
+        <param name="mode">See the description of the ZipArchiveMode enum. Read requires the stream to support reading, Create requires the stream to support writing, and Update requires the stream to support reading, writing, and seeking.</param>
+        <param name="leaveOpen">
+          <see langword="true" /> to leave the stream open upon disposing the ZipArchive, otherwise <see langword="false" />.</param>
+        <param name="entryNameEncoding">&lt;para&gt;The encoding to use when reading or writing entry names and comments in this ZipArchive.&lt;/para&gt;&lt;para&gt;///     &lt;para&gt;NOTE: Specifying this parameter to values other than &lt;see langword="null" /&gt; is discouraged.&lt;/para&gt;&lt;para&gt;However, this may be necessary for interoperability with ZIP archive tools and libraries that do not correctly support UTF-8 encoding for entry names.&lt;br /&gt; This value is used as follows:&lt;/para&gt;&lt;para&gt; &lt;strong&gt;Reading (opening) ZIP archive files:&lt;/strong&gt; &lt;/para&gt;&lt;para&gt;If &lt;c&gt;entryNameEncoding&lt;/c&gt; is not specified (&lt;c&gt;== null&lt;/c&gt;):&lt;/para&gt;&lt;list&gt; &lt;item&gt;For entries where the language encoding flag (EFS) in the general purpose bit flag of the local file header is &lt;em&gt;not&lt;/em&gt; set, use the current system default code page (&lt;c&gt;Encoding.Default&lt;/c&gt;) in order to decode the entry name and comment.&lt;/item&gt; &lt;item&gt;For entries where the language encoding flag (EFS) in the general purpose bit flag of the local file header &lt;em&gt;is&lt;/em&gt; set, use UTF-8 (&lt;c&gt;Encoding.UTF8&lt;/c&gt;) in order to decode the entry name and comment.&lt;/item&gt; &lt;/list&gt;&lt;para&gt;If &lt;c&gt;entryNameEncoding&lt;/c&gt; is specified (&lt;c&gt;!= null&lt;/c&gt;):&lt;/para&gt;&lt;list&gt; &lt;item&gt;For entries where the language encoding flag (EFS) in the general purpose bit flag of the local file header is &lt;em&gt;not&lt;/em&gt; set, use the specified &lt;c&gt;entryNameEncoding&lt;/c&gt; in order to decode the entry name and comment.&lt;/item&gt; &lt;item&gt;For entries where the language encoding flag (EFS) in the general purpose bit flag of the local file header &lt;em&gt;is&lt;/em&gt; set, use UTF-8 (&lt;c&gt;Encoding.UTF8&lt;/c&gt;) in order to decode the entry name and comment.&lt;/item&gt; &lt;/list&gt;&lt;para&gt; &lt;strong&gt;Writing (saving) ZIP archive files:&lt;/strong&gt; &lt;/para&gt;&lt;para&gt;If &lt;c&gt;entryNameEncoding&lt;/c&gt; is not specified (&lt;c&gt;== null&lt;/c&gt;):&lt;/para&gt;&lt;list&gt; &lt;item&gt;For entry names and comments that contain characters outside the ASCII range, the language encoding flag (EFS) will be set in the general purpose bit flag of the local file header, and UTF-8 (&lt;c&gt;Encoding.UTF8&lt;/c&gt;) will be used in order to encode the entry name and comment into bytes.&lt;/item&gt; &lt;item&gt;For entry names and comments that do not contain characters outside the ASCII range, the language encoding flag (EFS) will not be set in the general purpose bit flag of the local file header, and the current system default code page (&lt;c&gt;Encoding.Default&lt;/c&gt;) will be used to encode the entry names and comments into bytes.&lt;/item&gt; &lt;/list&gt;&lt;para&gt;If &lt;c&gt;entryNameEncoding&lt;/c&gt; is specified (&lt;c&gt;!= null&lt;/c&gt;):&lt;/para&gt;&lt;list&gt; &lt;item&gt;The specified &lt;c&gt;entryNameEncoding&lt;/c&gt; will always be used to encode the entry names and comments into bytes.&lt;/para&gt;&lt;para&gt;The language encoding flag (EFS) in the general purpose bit flag of the local file header will be set if and only if the specified &lt;c&gt;entryNameEncoding&lt;/c&gt; is a UTF-8 encoding.&lt;/item&gt; &lt;/list&gt;&lt;para&gt;Note that Unicode encodings other than UTF-8 may not be currently used for the &lt;c&gt;entryNameEncoding&lt;/c&gt;, otherwise an &lt;see cref="T:System.ArgumentException" /&gt; is thrown.&lt;/para&gt;</param>
+        <param name="cancellationToken">The optional cancellation token to monitor.</param>
+        <summary>Asynchronously initializes and returns a new instance of <see cref="T:System.IO.Compression.ZipArchive" /> on the given stream in the specified mode, specifying whether to leave the stream open, with an optional encoding and an optional cancellation token.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
+        <exception cref="T:System.ArgumentException">
+          <para>The stream is already closed.</para>
+          <para>-or-</para>
+          <para>mode is incompatible with the capabilities of the stream.</para>
+        </exception>
+        <exception cref="T:System.ArgumentNullException">The stream is <see langword="null" />.</exception>
+        <exception cref="T:System.ArgumentOutOfRangeException">mode specified an invalid value.</exception>
+        <exception cref="T:System.IO.InvalidDataException">
+          <para>The contents of the stream could not be interpreted as a Zip file.</para>
+          <para>-or-</para>
+          <para>mode is Update and an entry is missing from the archive or is corrupt and cannot be read.</para>
+          <para>-or-</para>
+          <para>mode is Update and an entry is too large to fit into memory.</para>
+        </exception>
+        <exception cref="T:System.ArgumentException">If a Unicode encoding other than UTF-8 is specified for the <code>entryNameEncoding</code>.</exception>
       </Docs>
     </Member>
     <MemberGroup MemberName="CreateEntry">

xml/System.IO.Compression/ZipArchiveEntry.xml

@@ -590,10 +590,23 @@ If the comment byte length is larger than <xref:System.UInt16.MaxValue>, it will
         <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="0" FrameworkAlternate="net-10.0" />
       </Parameters>
       <Docs>
-        <param name="cancellationToken">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <param name="cancellationToken">The token to monitor for cancellation requests.</param>
+        <summary>Asynchronously opens the entry. If the archive that the entry belongs to was opened in Read mode, the returned stream will be readable, and it may or may not be seekable. If Create mode, the returned stream will be writable and not seekable. If Update mode, the returned stream will be readable, writable, seekable, and support SetLength.</summary>
+        <returns>A Stream that represents the contents of the entry.</returns>
         <remarks>To be added.</remarks>
+        <exception cref="T:System.IO.IOException">
+          <para>The entry is already currently open for writing.</para>
+          <para>-or-</para>
+          <para>The entry has been deleted from the archive.</para>
+          <para>-or-</para>
+          <para>The archive that this entry belongs to was opened in ZipArchiveMode.Create, and this entry has already been written to once.</para>
+        </exception>
+        <exception cref="T:System.IO.InvalidDataException">
+          <para>The entry is missing from the archive or is corrupt and cannot be read.</para>
+          <para>-or-</para>
+          <para>The entry has been compressed using a compression method that is not supported.</para>
+        </exception>
+        <exception cref="T:System.ObjectDisposedException">The ZipArchive that this entry belongs to has been disposed.</exception>
       </Docs>
     </Member>
     <Member MemberName="ToString">