Skip to content
Closed
Changes from all commits
Commits
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
5 changes: 3 additions & 2 deletions xml/System.IO.Compression/BrotliStream.xml
Original file line number Diff line number Diff line change
Expand Up @@ -551,7 +551,8 @@
<remarks>
<para>The `DisposeAsync` method lets you perform a resource-intensive dispose operation without blocking the main thread. This performance consideration is particularly important in a Windows 8.x Store app or desktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. The async methods are used in conjunction with the <see langword="async" /> and <see langword="await" /> keywords in Visual Basic and C#.</para>
<para>This method disposes the Brotli stream by writing any changes to the backing store and closing the stream to release resources.</para>
<para>Calling `DisposeAsync` allows the resources used by the <see cref="T:System.IO.Compression.BrotliStream" /> to be reallocated for other purposes. For more information, see <see href="/dotnet/standard/garbage-collection/unmanaged">Cleaning Up Unmanaged Resources</see>.</para>
<para>Calling `DisposeAsync` allows the resources used by the <see cref="T:System.IO.Compression.BrotliStream" /> to be reallocated for other purposes. For more information, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged).</para>
Calling `DisposeAsync` allows the resources used by the <see cref="T:System.IO.Compression.BrotliStream" /> to be reallocated for other purposes. For more information, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged).
</remarks>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So the <para> tags mean Markdown links don't render...

image

</Docs>
</Member>
Expand Down Expand Up @@ -588,7 +589,7 @@
<param name="asyncResult">The reference to the pending asynchronous request to finish.</param>
<summary>Waits for the pending asynchronous read to complete. (Consider using the <see cref="M:System.IO.Stream.ReadAsync(System.Byte[],System.Int32,System.Int32)" /> method instead.)</summary>
<returns>The number of bytes read from the stream, between 0 (zero) and the number of bytes you requested. <see cref="T:System.IO.Compression.BrotliStream" /> returns 0 only at the end of the stream; otherwise, it blocks until at least one byte is available.</returns>
<remarks>To be added.</remarks>
<remarks>Calling `DisposeAsync` allows the resources used by the <see cref="T:System.IO.Compression.BrotliStream" /> to be reallocated for other purposes. For more information, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged).</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="asyncResult" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
Expand Down