Update System.Net.* APIs for .NET 10 #11915
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
There was a problem hiding this comment.
Pull Request Overview
This PR updates XML documentation for System.Net.* APIs to improve documentation completeness for .NET 10. The changes focus on adding missing <inheritdoc/> tags and providing proper <returns> descriptions for API methods.
- Added
<inheritdoc/>tags to methods that inherit documentation from base classes or interfaces - Replaced placeholder "To be added." return descriptions with specific documentation for IPAddress validation methods
- Updated documentation across networking-related classes including IPNetwork, IPAddress, WebSocketStream, and SslStream
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| xml/System.Net/IPNetwork.xml | Added <inheritdoc/> tag to ToString method documentation |
| xml/System.Net/IPAddress.xml | Added proper <returns> descriptions for IsValid methods and <inheritdoc/> tag for ToString method |
| xml/System.Net.WebSockets/WebSocketStream.xml | Added <inheritdoc/> tag to Dispose method documentation |
| xml/System.Net.Security/SslStream.xml | Added <inheritdoc/> tags to Read, Write, and WriteTimeout property documentation |
|
Tagging subscribers to this area: @dotnet/ncl |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 missing
<inheritdoc/>and<returns>for System.Net.* APIsFixes dotnet/runtime#120497
Fixes dotnet/runtime#120498
Fixes dotnet/runtime#120499