Reformat ZLibNative comments
#112585
Merged
Reformat ZLibNative comments
#112585
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
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.
|
Tagging subscribers to this area: @dotnet/area-system-io-compression |
This was referenced Feb 15, 2025
Open
carlossanlop
approved these changes
Feb 24, 2025
| @@ -64,51 +66,53 @@ public enum CompressionStrategy : int | |||
| } | |||
|
|
|||
| /// <summary> | |||
| /// In version 1.2.3, ZLib provides on the <code>Deflated</code>-<code>CompressionMethod</code>. | |||
| /// In version 2.2.1, zlib-ng provides only the <see cref="Deflated" /> <see cref="CompressionMethod" />. | |||
There was a problem hiding this comment.
Good catch. I assume zlib-ng 2.2.1 is the minimum version where this restriction was added?
There was a problem hiding this comment.
Thanks. I'm describing a lack of support for anything besides Deflated, so the restriction's been present from the outset. The only reason I've picked v2.2.1 is that it's the one we've used at time of writing.
There was a problem hiding this comment.
Ah okay. That's alright too.
|
/ba-g The Windows.Server2025.Amd64.Open failures are known dead-lettering in those machines. The stuck wasm leg was an unexpectedly restarted machine. |
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.
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.