-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Document API added in .NET 10.0 #120670
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document API added in .NET 10.0 #120670
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds comprehensive XML documentation to various .NET APIs that were previously undocumented, as part of documenting all APIs introduced in .NET 10.0. The documentation covers interop functionality, async helpers, collection marshalling, compression APIs, and various utility methods across multiple libraries.
Key Changes
- Added XML documentation for Java interop marshalling APIs across multiple runtime implementations
- Documented async helper methods and compression-related APIs
- Added parameter descriptions and return value documentation for various utility methods
Reviewed Changes
Copilot reviewed 26 out of 26 changed files in this pull request and generated 1 comment.
Show a summary per file
File | Description |
---|---|
src/libraries/System.Runtime.Serialization.Formatters/src/System/Runtime/Serialization/ObjectManager.cs | Added forInternalUseOnly annotation to TypeLoadExceptionHolder |
src/libraries/System.Runtime.Serialization.Formatters/src/System/Runtime/Serialization/DeserializationEventHandler.cs | Added forInternalUseOnly annotation to SerializationEventHandler |
src/libraries/System.Private.DataContractSerialization/src/System/Runtime/Serialization/DataContract.cs | Added inheritdoc tags for Equals and GetHashCode overrides |
src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/WeakGCHandle.T.cs | Added parameter documentation for SetTarget method |
src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/Marshal.cs | Added comprehensive documentation for HRESULT conversion methods |
src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/Java/JavaMarshal.Unsupported.cs | Added complete class and method documentation for Java marshalling APIs |
src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/GCHandleExtensions.cs | Added typeparam documentation for extension methods |
src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/CollectionsMarshal.cs | Added returns documentation for AsSpan method |
src/libraries/System.Private.CoreLib/src/System/Runtime/ExceptionServices/ExceptionHandling.cs | Added class summary and parameter documentation |
src/libraries/System.Private.CoreLib/src/System/Runtime/CompilerServices/Unsafe.cs | Added typeparam documentation for multiple unsafe methods |
src/libraries/System.Private.CoreLib/src/System/Runtime/CompilerServices/AsyncHelpers.cs | Added comprehensive documentation for async helper methods |
src/libraries/System.Private.CoreLib/src/System/MemoryExtensions.cs | Enhanced documentation for Contains, StartsWith, and EndsWith methods |
src/libraries/System.Private.CoreLib/src/System/Guid.cs | Added documentation for UTF-8 parsing methods |
src/libraries/System.Net.Security/src/System/Net/Security/SslStream.cs | Added inheritdoc tags for Stream method overrides |
src/libraries/System.Net.Primitives/src/System/Net/IPAddress.cs | Added returns documentation for IsValidUtf8 method |
src/libraries/System.Linq/src/System/Linq/Reverse.cs | Added complete documentation for Reverse methods |
src/libraries/System.Linq.Queryable/src/System/Linq/Queryable.cs | Added documentation for Shuffle method |
src/libraries/System.IO.Compression/src/System/IO/Compression/ZipArchive.Async.cs | Added returns and summary documentation for async methods |
src/libraries/System.IO.Compression.ZipFile/src/System/IO/Compression/ZipFileExtensions.ZipArchiveEntry.Extract.Async.cs | Added returns documentation and fixed parameter comment formatting |
src/libraries/System.IO.Compression.ZipFile/src/System/IO/Compression/ZipFileExtensions.ZipArchive.Extract.Async.cs | Added returns documentation for extract methods |
src/libraries/System.IO.Compression.ZipFile/src/System/IO/Compression/ZipFileExtensions.ZipArchive.Create.Async.cs | Updated returns documentation to reflect async nature |
src/libraries/System.IO.Compression.ZipFile/src/System/IO/Compression/ZipFile.Extract.Async.cs | Added returns documentation for async extract operations |
src/libraries/System.IO.Compression.ZipFile/src/System/IO/Compression/ZipFile.Create.Async.cs | Added returns documentation for async create operations |
src/libraries/System.Console/src/System/Console.cs | Added documentation for ReadOnlySpan overloads |
src/coreclr/nativeaot/System.Private.CoreLib/src/System/Runtime/InteropServices/Java/JavaMarshal.NativeAot.cs | Added complete documentation for NativeAOT Java marshalling implementation |
src/coreclr/System.Private.CoreLib/src/System/Runtime/InteropServices/Java/JavaMarshal.CoreCLR.cs | Added complete documentation for CoreCLR Java marshalling implementation |
...ression.ZipFile/src/System/IO/Compression/ZipFileExtensions.ZipArchiveEntry.Extract.Async.cs
Show resolved
Hide resolved
Tagging subscribers to this area: @dotnet/area-meta |
src/libraries/System.Linq.Queryable/src/System/Linq/Queryable.cs
Outdated
Show resolved
Hide resolved
src/libraries/System.Linq.Queryable/src/System/Linq/Queryable.cs
Outdated
Show resolved
Hide resolved
...eaot/System.Private.CoreLib/src/System/Runtime/InteropServices/Java/JavaMarshal.NativeAot.cs
Show resolved
Hide resolved
...eaot/System.Private.CoreLib/src/System/Runtime/InteropServices/Java/JavaMarshal.NativeAot.cs
Outdated
Show resolved
Hide resolved
...eaot/System.Private.CoreLib/src/System/Runtime/InteropServices/Java/JavaMarshal.NativeAot.cs
Outdated
Show resolved
Hide resolved
...eaot/System.Private.CoreLib/src/System/Runtime/InteropServices/Java/JavaMarshal.NativeAot.cs
Show resolved
Hide resolved
...eaot/System.Private.CoreLib/src/System/Runtime/InteropServices/Java/JavaMarshal.NativeAot.cs
Outdated
Show resolved
Hide resolved
...oreclr/System.Private.CoreLib/src/System/Runtime/InteropServices/Java/JavaMarshal.CoreCLR.cs
Show resolved
Hide resolved
...es/System.Private.CoreLib/src/System/Runtime/InteropServices/Java/JavaMarshal.Unsupported.cs
Show resolved
Hide resolved
src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/GCHandleExtensions.cs
Outdated
Show resolved
Hide resolved
src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/Marshal.cs
Show resolved
Hide resolved
src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/Marshal.cs
Show resolved
Hide resolved
...oreclr/System.Private.CoreLib/src/System/Runtime/InteropServices/Java/JavaMarshal.CoreCLR.cs
Outdated
Show resolved
Hide resolved
...eaot/System.Private.CoreLib/src/System/Runtime/InteropServices/Java/JavaMarshal.NativeAot.cs
Show resolved
Hide resolved
...eaot/System.Private.CoreLib/src/System/Runtime/InteropServices/Java/JavaMarshal.NativeAot.cs
Show resolved
Hide resolved
src/libraries/System.Private.CoreLib/src/System/Runtime/ExceptionServices/ExceptionHandling.cs
Outdated
Show resolved
Hide resolved
...es/System.Private.CoreLib/src/System/Runtime/InteropServices/Java/JavaMarshal.Unsupported.cs
Outdated
Show resolved
Hide resolved
src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/Marshal.cs
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IO.Compression LGTM
Related #120483, #120512, #120495, #120496, #120499, #120497, #120498, #120501, #120502, #120503, #120505, #120504, #120509, #120510
This was the result of a copilot agent being asked to document all undocumented API mentioned in #120483, with the exception of Numerics and Intrinsics. It did OK, but I had to clean a lot up.
Most of these will still need to be ported over, but I figured we might as well do it in source and review in runtime first, then I'll do a batch port.
Please review for accuracy