Add missing documentation - #131649
Open
alinpahontu2912 wants to merge 1 commit into
Open
Conversation
|
Azure Pipelines: Successfully started running 3 pipeline(s). 13 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
Contributor
|
Tagging subscribers to this area: @karelz, @dotnet/area-system-io-compression |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates XML documentation in the System.IO.Compression area to better describe existing members and correct a minor doc typo, improving API discoverability and reference docs quality.
Changes:
- Add missing XML docs for
ZipArchiveEntry.Crc32,ZipArchiveEntry.ExternalAttributes, andZipArchiveEntry.Open(FileAccess, ReadOnlySpan<char>). - Add XML docs for the
CompressionModeenum and its members. - Improve/extend BrotliStream XML docs (add exception docs for
WriteAsync(byte[],int,int,...)and fix a parameter description typo for async read).
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/libraries/System.IO.Compression/src/System/IO/Compression/ZipArchiveEntry.cs | Adds XML documentation for checksum/attributes and the password+access Open overload. |
| src/libraries/System.IO.Compression/src/System/IO/Compression/CompressionMode.cs | Adds enum and member summaries for CompressionMode. |
| src/libraries/System.IO.Compression.Brotli/src/System/IO/Compression/enc/BrotliStream.Compress.cs | Adds exception documentation to WriteAsync(byte[],int,int,...). |
| src/libraries/System.IO.Compression.Brotli/src/System/IO/Compression/dec/BrotliStream.Decompress.cs | Fixes a typo in the count parameter description. |
Comment on lines
+128
to
132
| /// <exception cref="System.ArgumentNullException"><paramref name="buffer" /> is <see langword="null" />.</exception> | ||
| /// <exception cref="System.ArgumentOutOfRangeException"><paramref name="offset" /> or <paramref name="count" /> is negative.</exception> | ||
| /// <exception cref="System.ArgumentException">The sum of <paramref name="offset" /> and <paramref name="count" /> is greater than the buffer length.</exception> | ||
| /// <exception cref="System.ObjectDisposedException">The write operation cannot be performed because the stream is closed.</exception> | ||
| /// <remarks><para>This method enables you to perform resource-intensive I/O operations without blocking the main thread. This performance consideration is particularly important in apps 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> |
rzikm
reviewed
Aug 3, 2026
Comment on lines
+276
to
+281
| /// <summary> | ||
| /// Gets or sets the external file attributes of the entry, whose meaning depends on the platform | ||
| /// that created the archive (for example, Unix file mode bits or Windows file attributes). | ||
| /// </summary> | ||
| /// <exception cref="InvalidOperationException">The entry has been deleted from the archive.</exception> | ||
| /// <exception cref="ObjectDisposedException">The archive that the entry belongs to has been disposed.</exception> |
Member
There was a problem hiding this comment.
This PR adds docs on some members that already existed in previous releases. I don't think these changes propagate to the website.
There is a tool for synchronizing between /// comments and public API docs, IIRC, the engineering team runs it before shipping the next .NET version so that newly added APIs (that have /// comments) get ported.
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
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.
Add or update missing documentation for Compression area methods/enums