Update MemberGroup elements (Microsoft* namespaces)#12817
Open
gewarren wants to merge 3 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates ECMA XML reference docs for several Microsoft.* namespaces by adjusting <MemberGroup> entries: removing <AssemblyInfo> blocks from overload groups and adding missing <summary> descriptions for some groups.
Changes:
- Removed
<AssemblyInfo>blocks from many<MemberGroup>elements acrossMicrosoft.*XML reference files. - Added new
<MemberGroup>entries (for example,.ctor,GetAccessControl,Add,TryGetData<T>) with summaries where they were missing.
Reviewed changes
Copilot reviewed 53 out of 53 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| xml/Microsoft.Win32/RegistryKey.xml | Removes <AssemblyInfo> from multiple overload groups (for example, CreateSubKey). |
| xml/Microsoft.Win32/RegistryAclExtensions.xml | Adds a GetAccessControl <MemberGroup> summary. |
| xml/Microsoft.Win32/Registry.xml | Removes <AssemblyInfo> from SetValue overload group. |
| xml/Microsoft.Win32/FileDialogCustomPlace.xml | Removes <AssemblyInfo> from .ctor overload group. |
| xml/Microsoft.Win32/CommonDialog.xml | Removes <AssemblyInfo> from ShowDialog overload group. |
| xml/Microsoft.Win32.SafeHandles/SafeWaitHandle.xml | Adds a .ctor <MemberGroup> summary. |
| xml/Microsoft.Win32.SafeHandles/SafeRegistryHandle.xml | Adds a .ctor <MemberGroup> summary. |
| xml/Microsoft.Win32.SafeHandles/SafeProcessHandle.xml | Adds a .ctor <MemberGroup> summary. |
| xml/Microsoft.Win32.SafeHandles/SafePipeHandle.xml | Adds a .ctor <MemberGroup> summary. |
| xml/Microsoft.Win32.SafeHandles/SafeNCryptKeyHandle.xml | Adds a .ctor <MemberGroup> summary. |
| xml/Microsoft.Win32.SafeHandles/SafeNCryptHandle.xml | Adds a .ctor <MemberGroup> summary. |
| xml/Microsoft.Win32.SafeHandles/SafeFileHandle.xml | Adds a .ctor <MemberGroup> summary. |
| xml/Microsoft.Win32.SafeHandles/SafeAccessTokenHandle.xml | Adds a .ctor <MemberGroup> summary. |
| xml/Microsoft.VisualBasic/VBMath.xml | Removes <AssemblyInfo> from Randomize and Rnd overload groups. |
| xml/Microsoft.VisualBasic/VBFixedArrayAttribute.xml | Removes <AssemblyInfo> from .ctor overload group. |
| xml/Microsoft.VisualBasic/VBCodeProvider.xml | Removes <AssemblyInfo> from .ctor overload group. |
| xml/Microsoft.VisualBasic/Strings.xml | Removes <AssemblyInfo> from multiple overload groups (for example, Asc, Join, UCase). |
| xml/Microsoft.VisualBasic/Interaction.xml | Removes <AssemblyInfo> from AppActivate and Environ overload groups. |
| xml/Microsoft.VisualBasic/FileSystem.xml | Removes <AssemblyInfo> from multiple overload groups (for example, ChDrive, Seek). |
| xml/Microsoft.VisualBasic/DateAndTime.xml | Removes <AssemblyInfo> from DateAdd, DateDiff, and DatePart overload groups. |
| xml/Microsoft.VisualBasic/Conversion.xml | Removes <AssemblyInfo> from multiple overload groups (for example, Hex, Val). |
| xml/Microsoft.VisualBasic/ComClassAttribute.xml | Removes <AssemblyInfo> from .ctor overload group. |
| xml/Microsoft.VisualBasic/Collection.xml | Removes <AssemblyInfo> from Item and Remove overload groups. |
| xml/Microsoft.VisualBasic.MyServices/RegistryProxy.xml | Removes <AssemblyInfo> from SetValue overload group. |
| xml/Microsoft.VisualBasic.MyServices/FileSystemProxy.xml | Removes <AssemblyInfo> from multiple overload groups (for example, CopyFile, WriteAllText). |
| xml/Microsoft.VisualBasic.MyServices/ClipboardProxy.xml | Removes <AssemblyInfo> from multiple overload groups and adds a TryGetData<T> <MemberGroup> with placeholder summary. |
| xml/Microsoft.VisualBasic.Logging/Log.xml | Removes <AssemblyInfo> from multiple overload groups (for example, .ctor, WriteEntry). |
| xml/Microsoft.VisualBasic.Logging/FileLogTraceListener.xml | Removes <AssemblyInfo> from multiple overload groups (for example, .ctor, TraceEvent). |
| xml/Microsoft.VisualBasic.FileIO/TextFieldParser.xml | Removes <AssemblyInfo> from .ctor and Dispose overload groups. |
| xml/Microsoft.VisualBasic.FileIO/MalformedLineException.xml | Removes <AssemblyInfo> from .ctor overload group. |
| xml/Microsoft.VisualBasic.FileIO/FileSystem.xml | Removes <AssemblyInfo> from multiple overload groups (for example, CopyDirectory, MoveFile). |
| xml/Microsoft.VisualBasic.Devices/Network.xml | Removes <AssemblyInfo> from DownloadFile, Ping, and UploadFile overload groups. |
| xml/Microsoft.VisualBasic.Devices/Keyboard.xml | Removes <AssemblyInfo> from SendKeys overload group. |
| xml/Microsoft.VisualBasic.Devices/Audio.xml | Removes <AssemblyInfo> from Play overload group. |
| xml/Microsoft.VisualBasic.CompilerServices/StringType.xml | Removes <AssemblyInfo> from multiple overload groups (for example, FromDecimal). |
| xml/Microsoft.VisualBasic.CompilerServices/SingleType.xml | Removes <AssemblyInfo> from multiple overload groups (for example, FromObject). |
| xml/Microsoft.VisualBasic.CompilerServices/ProjectData.xml | Removes <AssemblyInfo> from SetProjectError overload group. |
| xml/Microsoft.VisualBasic.CompilerServices/NewLateBinding.xml | Removes <AssemblyInfo> from LateSet overload group. |
| xml/Microsoft.VisualBasic.CompilerServices/IncompleteInitialization.xml | Removes <AssemblyInfo> from .ctor overload group. |
| xml/Microsoft.VisualBasic.CompilerServices/DoubleType.xml | Removes <AssemblyInfo> from multiple overload groups (for example, Parse). |
| xml/Microsoft.VisualBasic.CompilerServices/DecimalType.xml | Removes <AssemblyInfo> from multiple overload groups (for example, FromString). |
| xml/Microsoft.VisualBasic.CompilerServices/DateType.xml | Removes <AssemblyInfo> from FromString overload group. |
| xml/Microsoft.VisualBasic.CompilerServices/Conversions.xml | Removes <AssemblyInfo> from many overload groups (for example, ToBoolean, ToString). |
| xml/Microsoft.VisualBasic.ApplicationServices/WindowsFormsApplicationBase.xml | Removes <AssemblyInfo> from .ctor overload group. |
| xml/Microsoft.VisualBasic.ApplicationServices/User.xml | Removes <AssemblyInfo> from IsInRole overload group. |
| xml/Microsoft.VisualBasic.ApplicationServices/NoStartupFormException.xml | Removes <AssemblyInfo> from .ctor overload group. |
| xml/Microsoft.VisualBasic.ApplicationServices/CantStartSingleInstanceException.xml | Removes <AssemblyInfo> from .ctor overload group. |
| xml/Microsoft.SqlServer.Server/SqlMetaData.xml | Removes <AssemblyInfo> from .ctor and Adjust overload groups. |
| xml/Microsoft.SqlServer.Server/SqlDataRecord.xml | Removes <AssemblyInfo> from Item overload group. |
| xml/Microsoft.DotNet.PlatformAbstractions/HashCodeCombiner.xml | Adds an Add <MemberGroup> but leaves a placeholder summary. |
| xml/Microsoft.CSharp/CSharpCodeProvider.xml | Removes <AssemblyInfo> from .ctor overload group. |
| xml/Microsoft.CSharp.RuntimeBinder/RuntimeBinderInternalCompilerException.xml | Removes <AssemblyInfo> from .ctor overload group. |
| xml/Microsoft.CSharp.RuntimeBinder/RuntimeBinderException.xml | Removes <AssemblyInfo> from .ctor overload group. |
Comments suppressed due to low confidence (3)
xml/Microsoft.Win32/RegistryKey.xml:144
- This MemberGroup used to include an block. Other XML files still keep under (for example, System.Xml.Serialization/SoapElementAttribute.xml:82-90), and it can be used to surface assembly/version info for the overload group. Removing it here drops that metadata and also diverges from the established ECMAXML structure in the repo.
xml/Microsoft.CSharp.RuntimeBinder/RuntimeBinderException.xml:46 - This MemberGroup no longer has its block. MemberGroup-level assembly metadata is still present in other reference XML (for example, System.Xml.Serialization/SoapElementAttribute.xml:82-90), and removing it can cause the overload group page to lose assembly/version information.
<MemberGroup MemberName=".ctor">
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.CSharp.RuntimeBinder.RuntimeBinderException" /> class.</summary>
</Docs>
</MemberGroup>
xml/Microsoft.VisualBasic/VBMath.xml:63
- This overload group previously carried an block. If the docs pipeline uses MemberGroup-level metadata to describe the overload set’s assembly/version availability, removing it will drop that information.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Comment on lines
1935
to
1938
| <MemberGroup MemberName="OpenRemoteBaseKey"> | ||
| <AssemblyInfo> | ||
| <AssemblyName>mscorlib</AssemblyName> | ||
| <AssemblyVersion>4.0.0.0</AssemblyVersion> | ||
| </AssemblyInfo> | ||
| <Docs> | ||
| <summary>Opens a new T:Microsoft.Win32.RegistryKey that represents the requested key on a remote machine, with the option of specified registry view.</summary> | ||
| </Docs> |
| <AssemblyVersion>10.0.0.0</AssemblyVersion> | ||
| </AssemblyInfo> | ||
| <Docs> | ||
| <summary>Writes data from a variable to a disk file. The <see langword="My" /> feature gives you better productivity and performance in file I/O operations than <see langword="FilePut" />. F For more information, see <see cref="T:Microsoft.VisualBasic.FileIO.FileSystem" />.</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.