Add MemberGroup descriptions (System namespace)#12825
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> entries (and summaries) to many System namespace ECMA XML files, improving how overload sets are described in the generated .NET API reference docs.
Changes:
- Added
<MemberGroup>elements for many overloaded members (for example,Parse,TryParse,TryFormat, operators, and constructors) acrossSystemtypes. - Introduced new group-level
<summary>text to describe overload families consistently. - Expanded coverage to include spans/memory-related types and newer APIs that have multiple overloads.
Reviewed changes
Copilot reviewed 54 out of 54 changed files in this pull request and generated 17 comments.
Show a summary per file
| File | Description |
|---|---|
| xml/System/ArgumentNullException.xml | Adds ThrowIfNull member group summary. |
| xml/System/Array.xml | Adds member group summaries for generic overload sets (for example, BinarySearch<T>, Sort<T>). |
| xml/System/ArraySegment`1.xml | Adds member group summaries (for example, CopyTo, Slice). |
| xml/System/BinaryData.xml | Adds member group summaries for factory methods and conversions (for example, FromStream, op_Implicit). |
| xml/System/BitConverter.xml | Adds member group summaries for span-based conversions and TryWriteBytes. |
| xml/System/Boolean.xml | Adds member group summaries for Parse and TryParse span overloads. |
| xml/System/Byte.xml | Adds member group summary for TryFormat. |
| xml/System/Char.xml | Adds member group summary for explicit interface Parse. |
| xml/System/Convert.xml | Adds member group summaries for hex conversion APIs. |
| xml/System/DateOnly.xml | Adds member group summaries for constructors and parsing/formatting APIs. |
| xml/System/DateTime.xml | Adds member group summaries for Deconstruct and TryFormat. |
| xml/System/DateTimeOffset.xml | Adds member group summary for TryFormat. |
| xml/System/Decimal.xml | Adds member group summaries for GetBits and TryFormat. |
| xml/System/Double.xml | Adds member group summaries for Log, Round, and TryFormat. |
| xml/System/Enum.xml | Adds member group summaries for generic Parse<TEnum> / TryParse<TEnum>. |
| xml/System/GC.xml | Adds member group summary for GetGCMemoryInfo. |
| xml/System/Guid.xml | Adds member group summaries for parsing/formatting and RFC 9562 v7 APIs. |
| xml/System/Half.xml | Adds member group summaries across numeric APIs (compare/parse/format/operators). |
| xml/System/HashCode.xml | Adds member group summary for Add<T>. |
| xml/System/Index.xml | Adds member group summary for Equals. |
| xml/System/Int16.xml | Adds member group summary for TryFormat. |
| xml/System/Int32.xml | Adds member group summary for TryFormat. |
| xml/System/Int64.xml | Adds member group summary for TryFormat. |
| xml/System/Int128.xml | Adds member group summaries across numeric APIs (compare/parse/format/operators). |
| xml/System/IntPtr.xml | Adds member group summaries across numeric APIs (compare/parse/format/etc.). |
| xml/System/Math.xml | Adds member group summaries for BigMul and Clamp. |
| xml/System/MathF.xml | Adds member group summaries for Log and Round. |
| xml/System/Memory`1.xml | Adds member group summaries for constructors and common operations. |
| xml/System/MemoryExtensions.xml | Adds member group summaries for many span/memory extension overload families. |
| xml/System/MemoryExtensions+TryWriteInterpolatedStringHandler.xml | Adds member group summaries for constructor and AppendFormatted overload families. |
| xml/System/ObjectDisposedException.xml | Adds member group summary for ThrowIf. |
| xml/System/Random.xml | Adds member group summaries for new/random helper overload families. |
| xml/System/Range.xml | Adds member group summary for Equals. |
| xml/System/ReadOnlyMemory`1.xml | Adds member group summaries for constructors, equality, slicing, and conversions. |
| xml/System/ReadOnlySpan`1.xml | Adds member group summaries for constructor, implicit conversions, and slicing. |
| xml/System/SByte.xml | Adds member group summary for TryFormat. |
| xml/System/SequencePosition.xml | Adds member group summary for Equals. |
| xml/System/Single.xml | Adds member group summaries for Log, Round, and TryFormat. |
| xml/System/Span`1.xml | Adds member group summaries for constructor, implicit conversions, and slicing. |
| xml/System/String.xml | Adds member group summaries for multiple overload families (for example, Contains, Join<T>, TrimEnd). |
| xml/System/StringComparer.xml | Adds member group summary for Create. |
| xml/System/TimeOnly.xml | Adds member group summaries across constructors and parsing/formatting APIs. |
| xml/System/TimeProvider.xml | Adds member group summary for GetElapsedTime. |
| xml/System/TimeSpan.xml | Adds member group summaries for time-span operations and operators. |
| xml/System/TimeZoneInfo.xml | Adds member group summaries for time zone APIs (for example, GetSystemTimeZones). |
| xml/System/TimeZoneInfo+AdjustmentRule.xml | Adds member group summaries for CreateAdjustmentRule and Equals. |
| xml/System/Type.xml | Adds member group summary for GetMethodImpl. |
| xml/System/UInt16.xml | Adds member group summary for TryFormat. |
| xml/System/UInt32.xml | Adds member group summary for TryFormat. |
| xml/System/UInt64.xml | Adds member group summary for TryFormat. |
| xml/System/UInt128.xml | Adds member group summaries across numeric APIs (compare/parse/format/operators). |
| xml/System/UIntPtr.xml | Adds member group summaries across numeric APIs (compare/parse/format/etc.). |
| xml/System/Uri.xml | Adds member group summaries for Equals and span-based escape/unescape APIs. |
| xml/System/Version.xml | Adds member group summaries for parsing/formatting overload families. |
| </Member> | ||
| <MemberGroup MemberName="op_Division"> | ||
| <Docs> | ||
| <summary>Returns a new <see cref="T:System.Double" /> value that's the result of dividing <paramref name="t1" /> by <paramref name="t2" />.</summary> |
| </Member> | ||
| <MemberGroup MemberName="TryFormat"> | ||
| <Docs> | ||
| <summary>Tries to format the value of the current instance into the provided span of characters.</summary> |
| </Member> | ||
| <MemberGroup MemberName="TryFormat"> | ||
| <Docs> | ||
| <summary>Tries to format the value of the current instance into the provided span of characters.</summary> |
| </Member> | ||
| <MemberGroup MemberName="TryFormat"> | ||
| <Docs> | ||
| <summary>Tries to format the value of the current instance into the provided span of characters.</summary> |
| <Members> | ||
| <MemberGroup MemberName=".ctor"> | ||
| <Docs> | ||
| <summary>Initializes a new instance of the <see cref="T:System.ReadOnlyMemory`1" /> class.</summary> |
| <Members> | ||
| <MemberGroup MemberName=".ctor"> | ||
| <Docs> | ||
| <summary>Initializes a new instance of the <see cref="T:System.MemoryExtensions+TryWriteInterpolatedStringHandler" /> class.</summary> |
| <Members> | ||
| <MemberGroup MemberName="AsMemory"> | ||
| <Docs> | ||
| <summary>Creates a new <see langword="ReadOnlyMemory<Char>" /> over the portion of the target string.</summary> |
| </Member> | ||
| <MemberGroup MemberName="op_Implicit"> | ||
| <Docs> | ||
| <summary>Defines an implicit conversion from a <see cref="T:System.BinaryData" /> to a <see cref="T:System.ReadOnlySpan`1" />.</summary> |
| </Member> | ||
| <MemberGroup MemberName="Deconstruct"> | ||
| <Docs> | ||
| <summary>Deconstructs this <see cref="T:System.DateTime" /> instance by <see cref="T:System.DateOnly" /> and <see cref="T:System.TimeOnly" />.</summary> |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
| <Members> | ||
| <MemberGroup MemberName=".ctor"> | ||
| <Docs> | ||
| <summary>Initializes a new instance of the <see cref="T:System.TimeOnly" /> class.</summary> |
| <Members> | ||
| <MemberGroup MemberName=".ctor"> | ||
| <Docs> | ||
| <summary>Initializes a new instance of the <see cref="T:System.DateOnly" /> class.</summary> |
| <Members> | ||
| <MemberGroup MemberName=".ctor"> | ||
| <Docs> | ||
| <summary>Initializes a new instance of the <see cref="T:System.Span`1" /> class.</summary> |
| <Members> | ||
| <MemberGroup MemberName=".ctor"> | ||
| <Docs> | ||
| <summary>Initializes a new instance of the <see cref="T:System.ReadOnlySpan`1" /> class.</summary> |
| <Members> | ||
| <MemberGroup MemberName=".ctor"> | ||
| <Docs> | ||
| <summary>Initializes a new instance of the <see cref="T:System.Memory`1" /> class.</summary> |
| </Member> | ||
| <MemberGroup MemberName="TryFormat"> | ||
| <Docs> | ||
| <summary>Tries to format the value of the current instance as UTF-8 into the provided span of bytes.</summary> |
| </Member> | ||
| <MemberGroup MemberName="TryFormat"> | ||
| <Docs> | ||
| <summary>Tries to format the value of the current instance as UTF-8 into the provided span of bytes.</summary> |
| </Member> | ||
| <MemberGroup MemberName="TryFormat"> | ||
| <Docs> | ||
| <summary>Tries to format the value of the current instance as UTF-8 into the provided span of bytes.</summary> |
| </Member> | ||
| <MemberGroup MemberName="TryFormat"> | ||
| <Docs> | ||
| <summary>Tries to format the value of the current instance as UTF-8 into the provided span of bytes.</summary> |
| </Member> | ||
| <MemberGroup MemberName="TryFormat"> | ||
| <Docs> | ||
| <summary>Tries to format the value of the current instance as UTF-8 into the provided span of bytes.</summary> |
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.