Add MemberGroup descriptions (System.Windows)#12821
Draft
gewarren wants to merge 2 commits into
Draft
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds missing <MemberGroup> documentation blocks across System.Windows-related ECMAXML files, improving how overload groups (constructors/method overload sets) are described in the generated API reference docs. This aligns with the broader cleanup tracked in dotnet-api-docs#12626.
Changes:
- Add new
<MemberGroup>entries with<summary>text for common overload groups (for example,.ctor,Equals,Invoke*,Write,DoDragDrop). - Expand overload-group coverage across WPF, WinForms, Xps, and threading-related types.
- Add a constructor
<MemberGroup>toTaskDialogButton(plus formatting-only churn in that file).
Reviewed changes
Copilot reviewed 41 out of 41 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| xml/System.Windows/ThemeMode.xml | Adds Equals overload-group summary. |
| xml/System.Windows/RoutedPropertyChangedEventArgs`1.xml | Adds constructor overload-group summary. |
| xml/System.Windows.Xps/XpsDocumentWriter.xml | Adds Write overload-group summary. |
| xml/System.Windows.Threading/Dispatcher.xml | Adds Invoke<TResult> and InvokeAsync<TResult> overload-group summaries. |
| xml/System.Windows.Media.TextFormatting/TextLine.xml | Adds constructor overload-group summary. |
| xml/System.Windows.Media.Animation/EasingSingleKeyFrame.xml | Adds constructor overload-group summary. |
| xml/System.Windows.Media.Animation/EasingInt64KeyFrame.xml | Adds constructor overload-group summary. |
| xml/System.Windows.Media.Animation/EasingInt32KeyFrame.xml | Adds constructor overload-group summary. |
| xml/System.Windows.Media.Animation/EasingInt16KeyFrame.xml | Adds constructor overload-group summary. |
| xml/System.Windows.Media.Animation/EasingDoubleKeyFrame.xml | Adds constructor overload-group summary. |
| xml/System.Windows.Media.Animation/EasingDecimalKeyFrame.xml | Adds constructor overload-group summary. |
| xml/System.Windows.Media.Animation/EasingColorKeyFrame.xml | Adds constructor overload-group summary. |
| xml/System.Windows.Media.Animation/EasingByteKeyFrame.xml | Adds constructor overload-group summary. |
| xml/System.Windows.Markup/XmlAttributeProperties.xml | Adds SetXmlNamespaceMaps overload-group summary. |
| xml/System.Windows.Forms/UserControl.xml | Adds ValidateChildren overload-group summary. |
| xml/System.Windows.Forms/ToolStripRenderer.xml | Adds ScaleArrowOffsetsIfNeeded overload-group summary. |
| xml/System.Windows.Forms/ToolStripItem.xml | Adds DoDragDrop overload-group summary. |
| xml/System.Windows.Forms/TaskDialogVerificationCheckBox.xml | Adds constructor overload-group summary. |
| xml/System.Windows.Forms/TaskDialogRadioButton.xml | Adds constructor overload-group summary. |
| xml/System.Windows.Forms/TaskDialogProgressBar.xml | Adds constructor overload-group summary. |
| xml/System.Windows.Forms/TaskDialogIcon.xml | Adds constructor overload-group summary. |
| xml/System.Windows.Forms/TaskDialogFootnote.xml | Adds constructor overload-group summary. |
| xml/System.Windows.Forms/TaskDialogExpander.xml | Adds constructor overload-group summary. |
| xml/System.Windows.Forms/TaskDialogCommandLinkButton.xml | Adds constructor overload-group summary. |
| xml/System.Windows.Forms/TaskDialogButton.xml | Adds constructor overload-group summary (plus formatting-only churn). |
| xml/System.Windows.Forms/TaskDialog.xml | Adds ShowDialog / ShowDialogAsync overload-group summaries. |
| xml/System.Windows.Forms/TableLayoutPanelCellPosition.xml | Adds Equals overload-group summary. |
| xml/System.Windows.Forms/Padding.xml | Adds Equals overload-group summary. |
| xml/System.Windows.Forms/Message.xml | Adds Equals overload-group summary. |
| xml/System.Windows.Forms/LinkClickedEventArgs.xml | Adds constructor overload-group summary. |
| xml/System.Windows.Forms/LinkArea.xml | Adds Equals overload-group summary. |
| xml/System.Windows.Forms/GiveFeedbackEventArgs.xml | Adds constructor overload-group summary. |
| xml/System.Windows.Forms/Form.xml | Adds ShowDialogAsync overload-group summary. |
| xml/System.Windows.Forms/DrawItemEventArgs.xml | Adds Dispose overload-group summary. |
| xml/System.Windows.Forms/DragEventArgs.xml | Adds constructor overload-group summary. |
| xml/System.Windows.Forms/DomainUpDown+DomainUpDownAccessibleObject.xml | Adds constructor overload-group summary. |
| xml/System.Windows.Forms/Control.xml | Adds overload-group summaries for DoDragDrop, InvokeAsync, InvokeAsync<T>, and LogicalToDeviceUnits. |
| xml/System.Windows.Forms/BindingMemberInfo.xml | Adds Equals overload-group summary. |
| xml/System.Windows.Forms/AxHost+State.xml | Adds Dispose overload-group summary. |
| xml/System.Windows.Forms/AccessibleObject.xml | Adds overload-group summaries for explicit IReflect.GetMethod / IReflect.GetProperty. |
| xml/System.Windows.Documents/LineBreak.xml | Adds constructor overload-group summary. |
| </Member> | ||
| <MemberGroup MemberName="LogicalToDeviceUnits"> | ||
| <Docs> | ||
| <summary>Converts a Logical DPI value to its equivalent DeviceUnit DPI value.</summary> |
| </Member> | ||
| <MemberGroup MemberName="ScaleArrowOffsetsIfNeeded"> | ||
| <Docs> | ||
| <summary>Applies the <see cref="F:System.Windows.Forms.ToolStripRenderer.Offset2X" /> and <see cref="F:System.Windows.Forms.ToolStripRenderer.Offset2Y" /> values to scaling the arrow icon based on the specified DPI value.</summary> |
| </Member> | ||
| <MemberGroup MemberName="Write"> | ||
| <Docs> | ||
| <summary>Synchronously writes a specified XPS document to the target <see cref="T:System.Windows.Xps.Packaging.XpsDocument" /> or <see cref="T:System.Printing.PrintQueue" />.</summary> |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Comment on lines
+2831
to
+2835
| <MemberGroup MemberName="ScaleArrowOffsetsIfNeeded"> | ||
| <Docs> | ||
| <summary>Applies the <see cref="F:System.Windows.Forms.ToolStripRenderer.Offset2X" /> and <see cref="F:System.Windows.Forms.ToolStripRenderer.Offset2Y" /> values to scaling the arrow icon based on the specified DPI value.</summary> | ||
| </Docs> | ||
| </MemberGroup> |
Comment on lines
+9621
to
+9625
| <MemberGroup MemberName="LogicalToDeviceUnits"> | ||
| <Docs> | ||
| <summary>Converts a Logical DPI value to its equivalent DeviceUnit DPI value.</summary> | ||
| </Docs> | ||
| </MemberGroup> |
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.