Add \<para> tags to remarks comments #67173
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Tagging subscribers to this area: @dotnet/area-system-io-compression Issue DetailsThe <para> tags are necessary to retain line breaks in the docs.
|
danmoseley
approved these changes
Mar 28, 2022
| /// <remarks>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#. | ||
| /// This method disposes the Brotli stream by writing any changes to the backing store and closing the stream to release resources. | ||
| /// Calling `DisposeAsync` allows the resources used by the <see cref="System.IO.Compression.BrotliStream" /> to be reallocated for other purposes. For more information, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged).</remarks> | ||
| /// <remarks><para>This 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> |
There was a problem hiding this comment.
Can we remove the references to windows 8 store (and desktop) apps in these? Just apps or applications, need not be more specific. Looks like there's 5 references or so in these files
danmoseley
approved these changes
Mar 28, 2022
carlossanlop
approved these changes
Mar 29, 2022
There was a problem hiding this comment.
LGTM, thanks @gewarren. This should be an explicit requirement for triple slash comments to become source of truth of an assembly (like it is for System.IO.Compression.Brotli).
radekdoulik
pushed a commit
to radekdoulik/runtime
that referenced
this pull request
Mar 30, 2022
ghost
locked as resolved and limited conversation to collaborators
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The <para> tags are necessary to retain line breaks in the docs.