Reformat ZLibNative comments
#112585
Open
Reformat ZLibNative comments
#112585
+92
−80
Conversation
This file contains 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
Replace most instances of <code> with <c>, or <see> where relevant. Replace <p> with <para> to maintain paragraph structure. Update reference to current version number.
dotnet-policy-service
bot
added
the
community-contribution
|
Tagging subscribers to this area: @dotnet/area-system-io-compression |
This was referenced Feb 15, 2025
Open
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR reformats the internal XML comments for the
ZLibNativeclass so that they don't appear malformed in VS' Intellisense display.We previously used
<code>tags in the middle of sentences, or to refer to members. I've replaced these with<c>or<see>tags where appropriate.On other occasions, we used
<p>tags for a paragraph structure, which didn't appear to work properly. I've replaced these with<para>(with a few<br />s to handle subheadings.)Finally, there was one reference to the current ZLib version. I've updated this.