Skip to content

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

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
Nov 4, 2019
Merged

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

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2734154
Document System.IO.Compression.Brotli.BrotliDecoder
carlossanlop Oct 19, 2019
2ece2f0
suggestions
carlossanlop Nov 4, 2019
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
26 changes: 13 additions & 13 deletions xml/System.IO.Compression/BrotliDecoder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
</Interface>
</Interfaces>
<Docs>
<summary>To be added.</summary>
<summary>Provides non-allocating, performant single-pass Brotli decompression methods that are independent from the <see cref="T:System.IO.Compression.Brotli.BrotliDecoder" /> instance.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -52,12 +52,12 @@
<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>
<param name="source">The byte read-only span 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 can be returned from span-based operations that support processing of input contained in multiple discontiguous buffers.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -85,7 +85,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>
Expand Down Expand Up @@ -114,11 +114,11 @@
<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>
<param name="source">The byte read-only span 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>To be added.</remarks>
</Docs>
</Member>
Expand Down