Document System.IO.Compression.Brotli.BrotliDecoder (#3379)

Author: carlossanlop

xml/System.IO.Compression/BrotliDecoder.xml

@@ -22,7 +22,7 @@
     </Interface>
   </Interfaces>
   <Docs>
-    <summary>To be added.</summary>
+    <summary>Provides non-allocating, performant Brotli decompression methods. The methods decompress in a single pass without using a <see cref="T:System.IO.Compression.Brotli.BrotliStream" /> instance.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -52,13 +52,25 @@
         <Parameter Name="bytesWritten" Type="System.Int32" RefType="out" />
       </Parameters>
       <Docs>
-        <param name="source">To be added.</param>
-        <param name="destination">To be added.</param>
-        <param name="bytesConsumed">To be added.</param>
-        <param name="bytesWritten">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="source">A buffer containing the compressed data.</param>
+        <param name="destination">When this method returns, a byte span containing the decompressed data.</param>
+        <param name="bytesConsumed">The total number of bytes that were read from <paramref name="source" />.</param>
+        <param name="bytesWritten">The total number of bytes that were written in the <paramref name="destination" />.</param>
+        <summary>Decompresses data that was compressed using the Brotli algorithm.</summary>
+        <returns>One of the enumeration values that indicates the status of the decompression operation.</returns>
+         <remarks>
+           <format type="text/markdown"><![CDATA[
+
+## Remarks
+
+The return value can be as follows:
+- <xref:System.Buffers.OperationStatus.Done?displayProperty=nameWithType>: `source` was successfully and completely decompressed into `destination`.
+- <xref:System.Buffers.OperationStatus.DestinationTooSmall?displayProperty=nameWithType>: There is not enough space in `destination` to decompress `source`.
+- <xref:System.Buffers.OperationStatus.NeedMoreData?displayProperty=nameWithType>: The decompression action is partially done at least one more byte is required to complete the decompression task. This method should be called again with more input to decompress.
+- <xref:System.Buffers.OperationStatus.InvalidData?displayProperty=nameWithType>: The data in `source` is invalid and could not be decompressed.
+
+           ]]></format>
+         </remarks>
       </Docs>
     </Member>
     <Member MemberName="Dispose">
@@ -85,7 +97,7 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Releases all resources used by the current Brotli decoder instance.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -114,12 +126,20 @@
         <Parameter Name="bytesWritten" Type="System.Int32" RefType="out" />
       </Parameters>
       <Docs>
-        <param name="source">To be added.</param>
-        <param name="destination">To be added.</param>
-        <param name="bytesWritten">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="source">A buffer containing the compressed data.</param>
+        <param name="destination">When this method returns, a byte span containing the decompressed data.</param>
+        <param name="bytesWritten">The total number of bytes that were written in the <paramref name="destination" />.</param>
+        <summary>Attempts to decompress data that was compressed with the Brotli algorithm.</summary>
+        <returns><see langword="true" /> on success; <see langword="false" /> otherwise.</returns>
+         <remarks>
+           <format type="text/markdown"><![CDATA[
+
+## Remarks
+
+If this method returns `false`, `destination` may be empty or contain partially decompressed data, with `bytesWritten` being zero or greater than zero but less than the expected total.
+
+           ]]></format>
+         </remarks>
       </Docs>
     </Member>
   </Members>