Add MemberGroup descriptions (System.Runtime)#12824
Draft
gewarren wants to merge 2 commits into
Draft
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR contributes to issue #12626 by adding missing <MemberGroup> documentation blocks across a large set of System.Runtime-related ECMA XML files, primarily to improve “overload group” descriptions (constructors, operators, and method overload sets) in the generated API reference.
Changes:
- Add
<MemberGroup>entries (with<summary>) for constructors and overloaded members across many XML type files. - Add overload-group summaries for several SIMD/intrinsics APIs (X86/Arm) and vector types.
- Add overload-group summaries for interop/marshalling and runtime helper APIs.
Reviewed changes
Copilot reviewed 95 out of 101 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| xml/System.Runtime/AmbiguousImplementationException.xml | Add constructor overload-group summary (.ctor). |
| xml/System.Runtime.Versioning/UnsupportedOSPlatformAttribute.xml | Add constructor overload-group summary (.ctor). |
| xml/System.Runtime.Versioning/RequiresPreviewFeaturesAttribute.xml | Add constructor overload-group summary (.ctor). |
| xml/System.Runtime.Versioning/ObsoletedOSPlatformAttribute.xml | Add constructor overload-group summary (.ctor). |
| xml/System.Runtime.Serialization/ISerializationSurrogateProvider2.xml | Add overload-group summary for GetCustomDataToExport. |
| xml/System.Runtime.Serialization.DataContracts/DataContractSet.xml | Add constructor overload-group summary (.ctor). |
| xml/System.Runtime.Loader/AssemblyLoadContext.xml | Add overload-group summaries for .ctor, EnterContextualReflection, and LoadFromStream. |
| xml/System.Runtime.Intrinsics/Vector64`1.xml | Add overload-group summaries for Equals, op_Division, and op_Multiply. |
| xml/System.Runtime.Intrinsics/Vector64.xml | Add overload-group summaries for many Vector64 helper methods (Create/Convert/Shift/etc.). |
| xml/System.Runtime.Intrinsics/Vector512`1.xml | Add overload-group summaries for Equals, op_Division, and op_Multiply. |
| xml/System.Runtime.Intrinsics/Vector512.xml | Add overload-group summaries for many Vector512 helper methods (Create/Convert/Shift/etc.). |
| xml/System.Runtime.Intrinsics/Vector256`1.xml | Add overload-group summaries for Equals, op_Division, and op_Multiply. |
| xml/System.Runtime.Intrinsics/Vector256.xml | Add overload-group summaries for many Vector256 helper methods (Create/Convert/Shift/etc.). |
| xml/System.Runtime.Intrinsics/Vector128`1.xml | Add overload-group summaries for Equals, op_Division, and op_Multiply. |
| xml/System.Runtime.Intrinsics.X86/X86Base+X64.xml | Add overload-group summary for DivRem. |
| xml/System.Runtime.Intrinsics.X86/X86Base.xml | Add overload-group summary for DivRem. |
| xml/System.Runtime.Intrinsics.X86/Ssse3.xml | Add overload-group summaries for several SSSE3 intrinsics. |
| xml/System.Runtime.Intrinsics.X86/Sse42.xml | Add overload-group summary for Crc32. |
| xml/System.Runtime.Intrinsics.X86/Sse41+X64.xml | Add overload-group summaries for Extract and Insert. |
| xml/System.Runtime.Intrinsics.X86/Sse3.xml | Add overload-group summaries for several SSE3 intrinsics. |
| xml/System.Runtime.Intrinsics.X86/Sse2+X64.xml | Add overload-group summaries for ConvertToInt64 and StoreNonTemporal. |
| xml/System.Runtime.Intrinsics.X86/Sse.xml | Add overload-group summaries for scalar reciprocal/sqrt/sqrt operations. |
| xml/System.Runtime.Intrinsics.X86/Pclmulqdq+V512.xml | Add overload-group summary for CarrylessMultiply. |
| xml/System.Runtime.Intrinsics.X86/Pclmulqdq+V256.xml | Add overload-group summary for CarrylessMultiply. |
| xml/System.Runtime.Intrinsics.X86/Pclmulqdq.xml | Add overload-group summary for CarrylessMultiply. |
| xml/System.Runtime.Intrinsics.X86/Fma.xml | Add overload-group summaries for FMA multiply-add variants. |
| xml/System.Runtime.Intrinsics.X86/Bmi2+X64.xml | Add overload-group summary for MultiplyNoFlags. |
| xml/System.Runtime.Intrinsics.X86/Bmi2.xml | Add overload-group summary for MultiplyNoFlags. |
| xml/System.Runtime.Intrinsics.X86/Bmi1+X64.xml | Add overload-group summary for BitFieldExtract. |
| xml/System.Runtime.Intrinsics.X86/Bmi1.xml | Add overload-group summary for BitFieldExtract. |
| xml/System.Runtime.Intrinsics.X86/AvxVnni.xml | Add overload-group summaries for widening multiply-add intrinsics. |
| xml/System.Runtime.Intrinsics.X86/Avx512Vbmi2+VL.xml | Add overload-group summaries for VBMI2+VL operations (Compress/Store/etc.). |
| xml/System.Runtime.Intrinsics.X86/Avx512Vbmi2.xml | Add overload-group summaries for VBMI2 operations (Compress/Store/etc.). |
| xml/System.Runtime.Intrinsics.X86/Avx512Vbmi+VL.xml | Add overload-group summaries for VBMI+VL permute/multishift APIs. |
| xml/System.Runtime.Intrinsics.X86/Avx512Vbmi.xml | Add overload-group summaries for VBMI permute/multishift APIs. |
| xml/System.Runtime.Intrinsics.X86/Avx512F+X64.xml | Add overload-group summaries for various AVX-512F x64-only conversion APIs. |
| xml/System.Runtime.Intrinsics.X86/Avx512DQ+VL.xml | Add overload-group summaries for AVX-512DQ+VL APIs. |
| xml/System.Runtime.Intrinsics.X86/Avx512CD+VL.xml | Add overload-group summaries for AVX-512CD+VL APIs. |
| xml/System.Runtime.Intrinsics.X86/Avx512CD.xml | Add overload-group summaries for AVX-512CD APIs. |
| xml/System.Runtime.Intrinsics.X86/Avx512BW+VL.xml | Add overload-group summaries for AVX-512BW+VL APIs. |
| xml/System.Runtime.Intrinsics.X86/Avx10v2+V512.xml | Add overload-group summaries for AVX10v2 512-bit APIs. |
| xml/System.Runtime.Intrinsics.X86/Avx10v2.xml | Add overload-group summaries for AVX10v2 128-bit APIs. |
| xml/System.Runtime.Intrinsics.X86/Avx10v1+X64.xml | Add overload-group summaries for AVX10v1 x64-only conversion APIs. |
| xml/System.Runtime.Intrinsics.Arm/Rdm+Arm64.xml | Add overload-group summaries for Arm64 RDM scalar/lane operations. |
| xml/System.Runtime.Intrinsics.Arm/Rdm.xml | Add overload-group summaries for RDM vector/lane operations. |
| xml/System.Runtime.Intrinsics.Arm/Dp.xml | Add overload-group summaries for dot product operations. |
| xml/System.Runtime.Intrinsics.Arm/Crc32.xml | Add overload-group summaries for CRC32 and CRC32C operations. |
| xml/System.Runtime.Intrinsics.Arm/ArmBase+Arm64.xml | Add overload-group summaries for Arm64 base ops (CLZ/RBIT/etc.). |
| xml/System.Runtime.Intrinsics.Arm/ArmBase.xml | Add overload-group summaries for base ops (CLZ/RBIT/etc.). |
| xml/System.Runtime.Intrinsics.Arm/Aes.xml | Add overload-group summaries for polynomial multiply widening APIs. |
| xml/System.Runtime.InteropServices/TypeMapAttribute`1.xml | Add constructor overload-group summary (.ctor). |
| xml/System.Runtime.InteropServices/TensorMarshal.xml | Add overload-group summary for GetReference<T>. |
| xml/System.Runtime.InteropServices/NFloat.xml | Add overload-group summaries for ctor and multiple overload sets. |
| xml/System.Runtime.InteropServices/NativeMemory.xml | Add overload-group summaries for Alloc and AllocZeroed. |
| xml/System.Runtime.InteropServices/NativeLibrary.xml | Add overload-group summaries for Load and TryLoad. |
| xml/System.Runtime.InteropServices/MemoryMarshal.xml | Add overload-group summaries for AsBytes<T>, AsRef<T>, etc. |
| xml/System.Runtime.InteropServices/Marshal.xml | Add overload-group summaries for PtrToStringUTF8, PtrToStructure<T>, and SizeOf<T>. |
| xml/System.Runtime.InteropServices/HandleCollector.xml | Add constructor overload-group summary (.ctor). |
| xml/System.Runtime.InteropServices/GCHandle.xml | Add overload-group summary for Equals. |
| xml/System.Runtime.InteropServices/CULong.xml | Add overload-group summaries for ctor and Equals. |
| xml/System.Runtime.InteropServices/ComWrappers.xml | Add overload-group summaries for key COM wrapper methods. |
| xml/System.Runtime.InteropServices/CLong.xml | Add overload-group summaries for ctor and Equals. |
| xml/System.Runtime.InteropServices/BStrWrapper.xml | Add constructor overload-group summary (.ctor). |
| xml/System.Runtime.InteropServices.Marshalling/StrategyBasedComWrappers.xml | Add overload-group summary for CreateObject. |
| xml/System.Runtime.InteropServices.Marshalling/SpanMarshaller`2+ManagedToUnmanagedIn.xml | Add overload-group summary for GetPinnableReference. |
| xml/System.Runtime.InteropServices.Marshalling/ReadOnlySpanMarshaller`2+ManagedToUnmanagedIn.xml | Add overload-group summary for GetPinnableReference. |
| xml/System.Runtime.InteropServices.Marshalling/PointerArrayMarshaller`2+ManagedToUnmanagedIn.xml | Add overload-group summary for GetPinnableReference. |
| xml/System.Runtime.InteropServices.Marshalling/MarshalUsingAttribute.xml | Add constructor overload-group summary (.ctor). |
| xml/System.Runtime.InteropServices.Marshalling/ArrayMarshaller`2+ManagedToUnmanagedIn.xml | Add overload-group summary for GetPinnableReference. |
| xml/System.Runtime.InteropServices.JavaScript/JSObject.xml | Add overload-group summary for SetProperty. |
| xml/System.Runtime.InteropServices.JavaScript/JSMarshalerType.xml | Add overload-group summaries for Action, Function, and Task. |
| xml/System.Runtime.InteropServices.JavaScript/JSMarshalerArgument.xml | Add overload-group summaries for ToJS*/ToManaged* APIs. |
| xml/System.Runtime.InteropServices.JavaScript/JSImportAttribute.xml | Add constructor overload-group summary (.ctor). |
| xml/System.Runtime.ExceptionServices/ExceptionDispatchInfo.xml | Add overload-group summary for Throw. |
| xml/System.Runtime.CompilerServices/Unsafe.xml | Add overload-group summaries for numerous Unsafe APIs. |
| xml/System.Runtime.CompilerServices/TupleElementNamesAttribute.xml | Add constructor overload-group summary (.ctor). |
| xml/System.Runtime.CompilerServices/SwitchExpressionException.xml | Add constructor overload-group summary (.ctor). |
| xml/System.Runtime.CompilerServices/StrongBox`1.xml | Add constructor overload-group summary (.ctor). |
| xml/System.Runtime.CompilerServices/RuntimeHelpers.xml | Add overload-group summary for AllocateTypeAssociatedMemory. |
| xml/System.Runtime.CompilerServices/ReferenceAssemblyAttribute.xml | Add constructor overload-group summary (.ctor). |
| xml/System.Runtime.CompilerServices/ReadOnlyCollectionBuilder`1.xml | Add overload-group summaries for ctor and Reverse. |
| xml/System.Runtime.CompilerServices/NullableAttribute.xml | Add constructor overload-group summary (.ctor). |
| xml/System.Runtime.CompilerServices/InterpolatedStringHandlerArgumentAttribute.xml | Add constructor overload-group summary (.ctor). |
| xml/System.Runtime.CompilerServices/DefaultInterpolatedStringHandler.xml | Add overload-group summaries for ctor and AppendFormatted*. |
| xml/System.Runtime.CompilerServices/ConditionalWeakTable`2.xml | Add overload-group summaries for GetOrAdd and Remove. |
| xml/System.Runtime.Caching/MemoryCache.xml | Add constructor overload-group summary (.ctor). |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
Contributes to #12626.