Add MemberGroup descriptions (Microsoft.Extensions)#12827
Draft
gewarren wants to merge 2 commits into
Draft
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the .NET API reference ECMAXML documentation across multiple Microsoft.Extensions.* assemblies by adding missing <MemberGroup> entries (primarily for overloaded members and constructors) so overload groups have a shared description, aligning with the cleanup requested in #12626.
Changes:
- Added
<MemberGroup>documentation (summaries) for overload sets such as constructors (.ctor) and commonly overloaded methods (for example,Define,Validate,AddUserSecrets,AddConsole,CheckHealthAsync). - Normalized/adjusted XML structure in a few files where member group additions required reflow.
- Improved overload-group discoverability for DocFX output by ensuring group-level summaries exist.
Reviewed changes
Copilot reviewed 152 out of 152 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| xml/Microsoft.Extensions.VectorData/VectorStoreVectorProperty.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.VectorData/VectorStoreException.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.VectorData/VectorStoreCollectionOptions.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.VectorData/VectorStoreCollection`2.xml | Add MemberGroup summaries for overload sets (DeleteAsync/Dispose/GetAsync/UpsertAsync). |
| xml/Microsoft.Extensions.VectorData/VectorStore.xml | Add Dispose MemberGroup summary. |
| xml/Microsoft.Extensions.Time.Testing/FakeTimeProvider.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Primitives/StringValues.xml | Add MemberGroup summaries for overload sets (ctor/Concat/Equals/operators). |
| xml/Microsoft.Extensions.Primitives/StringTokenizer.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Primitives/StringSegment.xml | Add MemberGroup summaries for overload sets (ctor/AsSpan/Equals/IndexOf/IndexOfAny/op_Implicit/Subsegment/Substring). |
| xml/Microsoft.Extensions.Primitives/InplaceStringBuilder.xml | Add Append MemberGroup summary. |
| xml/Microsoft.Extensions.Options/ValidateOptionsResultBuilder.xml | Add AddResult MemberGroup summary. |
| xml/Microsoft.Extensions.Options/ValidateOptionsResult.xml | Add Fail MemberGroup summary. |
| xml/Microsoft.Extensions.Options/ValidateObjectMembersAttribute.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Options/ValidateEnumeratedItemsAttribute.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Options/PostConfigureOptions`6.xml | Add PostConfigure MemberGroup summary. |
| xml/Microsoft.Extensions.Options/PostConfigureOptions`5.xml | Add PostConfigure MemberGroup summary. |
| xml/Microsoft.Extensions.Options/PostConfigureOptions`4.xml | Add PostConfigure MemberGroup summary. |
| xml/Microsoft.Extensions.Options/PostConfigureOptions`3.xml | Add PostConfigure MemberGroup summary. |
| xml/Microsoft.Extensions.Options/PostConfigureOptions`2.xml | Add PostConfigure MemberGroup summary. |
| xml/Microsoft.Extensions.Options/OptionsFactory`1.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Options/OptionsBuilder`1.xml | Add MemberGroup summaries for Validate overload sets. |
| xml/Microsoft.Extensions.Options/NamedConfigureFromConfigurationOptions`1.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Options/ConfigureNamedOptions`6.xml | Add Configure MemberGroup summary. |
| xml/Microsoft.Extensions.Options/ConfigureNamedOptions`5.xml | Add Configure MemberGroup summary. |
| xml/Microsoft.Extensions.Options/ConfigureNamedOptions`4.xml | Add Configure MemberGroup summary. |
| xml/Microsoft.Extensions.Options/ConfigureNamedOptions`3.xml | Add Configure MemberGroup summary. |
| xml/Microsoft.Extensions.Options/ConfigureNamedOptions`2.xml | Add Configure MemberGroup summary. |
| xml/Microsoft.Extensions.Options/ConfigureNamedOptions`1.xml | Add Configure MemberGroup summary. |
| xml/Microsoft.Extensions.Options/ConfigurationChangeTokenSource`1.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.ObjectPool/ObjectPoolProviderExtensions.xml | Add CreateStringBuilderPool MemberGroup summary. |
| xml/Microsoft.Extensions.ObjectPool/ObjectPoolProvider.xml | Add Create<T> MemberGroup summary. |
| xml/Microsoft.Extensions.ObjectPool/DefaultObjectPool`1.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Logging/TraceSourceFactoryExtensions.xml | Add AddTraceSource MemberGroup summary. |
| xml/Microsoft.Extensions.Logging/SamplingLoggerBuilderExtensions.xml | Add AddRandomProbabilisticSampler MemberGroup summary. |
| xml/Microsoft.Extensions.Logging/LoggingRedactionExtensions.xml | Add EnableRedaction MemberGroup summary. |
| xml/Microsoft.Extensions.Logging/LoggingEnrichmentExtensions.xml | Add EnableEnrichment MemberGroup summary. |
| xml/Microsoft.Extensions.Logging/LoggerMessageAttribute.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Logging/LoggerMessage.xml | Add MemberGroup summaries for Define overload sets. |
| xml/Microsoft.Extensions.Logging/LoggerFactory.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Logging/LoggerExtensions.xml | Add MemberGroup summaries for Log* overload sets. |
| xml/Microsoft.Extensions.Logging/ITagCollector.xml | Add Add MemberGroup summary. |
| xml/Microsoft.Extensions.Logging/GlobalBufferLoggingBuilderExtensions.xml | Add AddGlobalBuffer MemberGroup summary. |
| xml/Microsoft.Extensions.Logging/FilterLoggingBuilderExtensions.xml | Add MemberGroup summaries for AddFilter overload sets. |
| xml/Microsoft.Extensions.Logging/FakeLoggerBuilderExtensions.xml | Add AddFakeLogging MemberGroup summary. |
| xml/Microsoft.Extensions.Logging/EventSourceLoggerFactoryExtensions.xml | Add AddEventSourceLogger MemberGroup summary. |
| xml/Microsoft.Extensions.Logging/EventLoggerFactoryExtensions.xml | Add AddEventLog MemberGroup summary. |
| xml/Microsoft.Extensions.Logging/EventId.xml | Add Equals MemberGroup summary. |
| xml/Microsoft.Extensions.Logging/DebugLoggerFactoryExtensions.xml | Add AddDebug MemberGroup summary. |
| xml/Microsoft.Extensions.Logging/ConsoleLoggerExtensions.xml | Add MemberGroup summaries for AddConsole/AddConsoleFormatter/AddJsonConsole/AddSimpleConsole/AddSystemdConsole. |
| xml/Microsoft.Extensions.Logging/AzureAppServicesLoggerFactoryExtensions.xml | Add AddAzureWebAppDiagnostics MemberGroup summary. |
| xml/Microsoft.Extensions.Logging.TraceSource/TraceSourceLoggerProvider.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Logging.Testing/FakeLoggerProvider.xml | Add Dispose MemberGroup summary. |
| xml/Microsoft.Extensions.Logging.Testing/FakeLogger`1.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Logging.Testing/FakeLogger.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Logging.Testing/FakeLogCollector.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Logging.EventLog/EventLogLoggerProvider.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Logging.Console/ConsoleLoggerProvider.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Localization/StringLocalizerExtensions.xml | Add GetString MemberGroup summary. |
| xml/Microsoft.Extensions.Localization/ResourceManagerStringLocalizerFactory.xml | Add MemberGroup summaries for Create/GetResourcePrefix. |
| xml/Microsoft.Extensions.Localization/ResourceManagerStringLocalizer.xml | Add GetAllStrings MemberGroup summary. |
| xml/Microsoft.Extensions.Localization/LocalizedString.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Localization/IStringLocalizerFactory.xml | Add Create MemberGroup summary. |
| xml/Microsoft.Extensions.Http/PolicyHttpMessageHandler.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Http.Resilience/StandardHedgingHandlerBuilderExtensions.xml | Add Configure MemberGroup summary. |
| xml/Microsoft.Extensions.Http.Resilience/RoutingStrategyBuilderExtensions.xml | Add MemberGroup summaries for ConfigureOrderedGroups/ConfigureWeightedGroups. |
| xml/Microsoft.Extensions.Http.Resilience/ResilienceHandler.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Http.Resilience/HttpStandardResiliencePipelineBuilderExtensions.xml | Add Configure MemberGroup summary. |
| xml/Microsoft.Extensions.Http.Resilience/HttpClientResiliencePredicates.xml | Add IsTransient MemberGroup summary. |
| xml/Microsoft.Extensions.Http.Resilience/HttpClientHedgingResiliencePredicates.xml | Add IsTransient MemberGroup summary. |
| xml/Microsoft.Extensions.Http.Logging/LoggingScopeHttpMessageHandler.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Http.Logging/LoggingHttpMessageHandler.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Http.Diagnostics/RequestMetadata.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Hosting/WindowsServiceLifetimeHostBuilderExtensions.xml | Add MemberGroup summaries for AddWindowsService/UseWindowsService. |
| xml/Microsoft.Extensions.Hosting/IHostBuilder.xml | Add UseServiceProviderFactory<TContainerBuilder> MemberGroup summary. |
| xml/Microsoft.Extensions.Hosting/HostingHostBuilderExtensions.xml | Add MemberGroup summaries for several host builder extension overload sets. |
| xml/Microsoft.Extensions.Hosting/HostBuilder.xml | Add UseServiceProviderFactory<TContainerBuilder> MemberGroup summary. |
| xml/Microsoft.Extensions.Hosting/HostApplicationBuilder.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Hosting/HostAbortedException.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Hosting/Host.xml | Add MemberGroup summaries for CreateApplicationBuilder/CreateDefaultBuilder. |
| xml/Microsoft.Extensions.Hosting/FakeHostingExtensions.xml | Add MemberGroup summaries for ConfigureAppConfiguration/ConfigureHostConfiguration. |
| xml/Microsoft.Extensions.Hosting.WindowsServices/WindowsServiceLifetime.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Hosting.Testing/FakeHost.xml | Add CreateBuilder MemberGroup summary. |
| xml/Microsoft.Extensions.Hosting.Internal/ConsoleLifetime.xml | Add constructor (.ctor) MemberGroup summary (plus structural reflow). |
| xml/Microsoft.Extensions.FileSystemGlobbing/PatternMatchingResult.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.FileSystemGlobbing/MatcherExtensions.xml | Add Match MemberGroup summary. |
| xml/Microsoft.Extensions.FileSystemGlobbing/Matcher.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.FileSystemGlobbing/FilePatternMatch.xml | Add Equals MemberGroup summary. |
| xml/Microsoft.Extensions.FileSystemGlobbing.Internal/IPatternContext.xml | Add Test MemberGroup summary. |
| xml/Microsoft.Extensions.FileSystemGlobbing.Internal.Patterns/PatternBuilder.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.FileSystemGlobbing.Internal.PatternContexts/PatternContext`1.xml | Add Test MemberGroup summary. |
| xml/Microsoft.Extensions.FileProviders/PhysicalFileProvider.xml | Add MemberGroup summaries for ctor/Dispose. |
| xml/Microsoft.Extensions.FileProviders/ManifestEmbeddedFileProvider.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.FileProviders/EmbeddedFileProvider.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.FileProviders/CompositeFileProvider.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.FileProviders.Physical/PhysicalFilesWatcher.xml | Add MemberGroup summaries for ctor/Dispose. |
| xml/Microsoft.Extensions.FileProviders.Internal/PhysicalDirectoryContents.xml | Add constructor (.ctor) MemberGroup summary (plus structural reflow). |
| xml/Microsoft.Extensions.Diagnostics.ResourceMonitoring/ResourceMonitoringBuilderExtensions.xml | Add ConfigureMonitor MemberGroup summary. |
| xml/Microsoft.Extensions.Diagnostics.Metrics/MetricsBuilderExtensions.xml | Add MemberGroup summaries for EnableMetrics/DisableMetrics. |
| xml/Microsoft.Extensions.Diagnostics.Metrics/HistogramAttribute`1.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Diagnostics.Metrics/HistogramAttribute.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Diagnostics.Metrics/GaugeAttribute`1.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Diagnostics.Metrics/GaugeAttribute.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Diagnostics.Metrics/CounterAttribute`1.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Diagnostics.Metrics/CounterAttribute.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Diagnostics.Metrics.Testing/MetricCollector`1.xml | Add MemberGroup summaries for ctor/WaitForMeasurementsAsync. |
| xml/Microsoft.Extensions.Diagnostics.Metrics.Testing/MeasurementExtensions.xml | Add MemberGroup summaries for ContainsTags/MatchesTags. |
| xml/Microsoft.Extensions.Diagnostics.Metrics.Testing/CollectedMeasurement`1.xml | Add MemberGroup summaries for ContainsTags/MatchesTags. |
| xml/Microsoft.Extensions.Diagnostics.Latency/Measure.xml | Add Equals MemberGroup summary. |
| xml/Microsoft.Extensions.Diagnostics.Latency/Checkpoint.xml | Add Equals MemberGroup summary. |
| xml/Microsoft.Extensions.Diagnostics.HealthChecks/HealthReportEntry.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Diagnostics.HealthChecks/HealthReport.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Diagnostics.HealthChecks/HealthCheckService.xml | Add CheckHealthAsync MemberGroup summary. |
| xml/Microsoft.Extensions.Diagnostics.HealthChecks/HealthCheckRegistration.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Diagnostics.ExceptionSummarization/ExceptionSummary.xml | Add Equals MemberGroup summary. |
| xml/Microsoft.Extensions.DiagnosticAdapter/DiagnosticSourceAdapter.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.DiagnosticAdapter.Internal/ProxyList`2.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.DataIngestion/IngestionPipeline`1.xml | Add ProcessAsync MemberGroup summary. |
| xml/Microsoft.Extensions.DataIngestion/IngestionDocumentSection.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.DataIngestion/IngestionDocumentReader.xml | Add ReadAsync MemberGroup summary. |
| xml/Microsoft.Extensions.DataIngestion/IngestionChunkWriter`1.xml | Add Dispose MemberGroup summary. |
| xml/Microsoft.Extensions.Configuration/XmlConfigurationExtensions.xml | Add AddXmlFile MemberGroup summary. |
| xml/Microsoft.Extensions.Configuration/UserSecretsConfigurationExtensions.xml | Add MemberGroup summaries for AddUserSecrets overload sets. |
| xml/Microsoft.Extensions.Configuration/StreamConfigurationProvider.xml | Add Load MemberGroup summary. |
| xml/Microsoft.Extensions.Configuration/MemoryConfigurationBuilderExtensions.xml | Add AddInMemoryCollection MemberGroup summary. |
| xml/Microsoft.Extensions.Configuration/KeyPerFileConfigurationBuilderExtensions.xml | Add AddKeyPerFile MemberGroup summary. |
| xml/Microsoft.Extensions.Configuration/JsonConfigurationExtensions.xml | Add AddJsonFile MemberGroup summary. |
| xml/Microsoft.Extensions.Configuration/IniConfigurationExtensions.xml | Add AddIniFile MemberGroup summary. |
| xml/Microsoft.Extensions.Configuration/FileConfigurationProvider.xml | Add MemberGroup summaries for Dispose/Load overload sets (plus structural reflow). |
| xml/Microsoft.Extensions.Configuration/EnvironmentVariablesExtensions.xml | Add AddEnvironmentVariables MemberGroup summary. |
| xml/Microsoft.Extensions.Configuration/ConfigurationRootExtensions.xml | Add GetDebugView MemberGroup summary. |
| xml/Microsoft.Extensions.Configuration/ConfigurationPath.xml | Add Combine MemberGroup summary. |
| xml/Microsoft.Extensions.Configuration/ConfigurationExtensions.xml | Add AsEnumerable MemberGroup summary. |
| xml/Microsoft.Extensions.Configuration/ConfigurationBinder.xml | Add MemberGroup summaries for Bind/Get/Get<T>/GetValue/GetValue<T>. |
| xml/Microsoft.Extensions.Configuration/CommandLineConfigurationExtensions.xml | Add AddCommandLine MemberGroup summary. |
| xml/Microsoft.Extensions.Configuration/ChainedBuilderExtensions.xml | Add AddConfiguration MemberGroup summary. |
| xml/Microsoft.Extensions.Configuration.EnvironmentVariables/EnvironmentVariablesConfigurationProvider.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Compliance.Testing/RedactorRequested.xml | Add Equals MemberGroup summary. |
| xml/Microsoft.Extensions.Compliance.Testing/RedactedData.xml | Add Equals MemberGroup summary. |
| xml/Microsoft.Extensions.Compliance.Redaction/Redactor.xml | Add MemberGroup summaries for GetRedactedLength/Redact overload sets. |
| xml/Microsoft.Extensions.Compliance.Redaction/RedactionExtensions.xml | Add SetHmacRedactor MemberGroup summary. |
| xml/Microsoft.Extensions.Compliance.Redaction/FakeRedactionBuilderExtensions.xml | Add SetFakeRedactor MemberGroup summary. |
| xml/Microsoft.Extensions.Compliance.Classification/DataClassificationSet.xml | Add MemberGroup summaries for ctor/Equals. |
| xml/Microsoft.Extensions.Compliance.Classification/DataClassification.xml | Add Equals MemberGroup summary. |
| xml/Microsoft.Extensions.Caching.Memory/MemoryCacheEntryExtensions.xml | Add MemberGroup summaries for RegisterPostEvictionCallback/SetAbsoluteExpiration. |
| xml/Microsoft.Extensions.Caching.Memory/MemoryCache.xml | Add MemberGroup summaries for ctor/Dispose/TryGetValue. |
| xml/Microsoft.Extensions.Caching.Memory/CacheExtensions.xml | Add MemberGroup summaries for GetOrCreate/GetOrCreateAsync/Set overload sets. |
| xml/Microsoft.Extensions.Caching.Memory/CacheEntryExtensions.xml | Add MemberGroup summaries for RegisterPostEvictionCallback/SetAbsoluteExpiration. |
| xml/Microsoft.Extensions.Caching.Hybrid/HybridCache.xml | Add MemberGroup summaries for GetOrCreateAsync overload sets and removal methods. |
| xml/Microsoft.Extensions.Caching.Distributed/MemoryDistributedCache.xml | Add constructor (.ctor) MemberGroup summary. |
| xml/Microsoft.Extensions.Caching.Distributed/DistributedCacheExtensions.xml | Add MemberGroup summaries for SetString/SetStringAsync. |
| xml/Microsoft.Extensions.Caching.Distributed/DistributedCacheEntryExtensions.xml | Add SetAbsoluteExpiration MemberGroup summary. |
| xml/Microsoft.Extensions.AsyncState/AsyncStateToken.xml | Add Equals MemberGroup summary. |
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.