Skip to content

Commit 42a146a

Browse files
authored
Add summaries for Microsoft.Extensions namespaces (#11135)
1 parent 60b48d6 commit 42a146a

File tree

66 files changed

+73
-66
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+73
-66
lines changed
+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.AI.Evaluation.Quality">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains evaluator classes that assess the quality of large language model (LLM) responses in an app according to various metrics.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.AI.Evaluation.Reporting.Formats.Html">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains classes for generating HTML reports that contain evaluation metrics for AI models.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.AI.Evaluation.Reporting.Formats.Json">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains classes for generating JSON reports that contain evaluation metrics for AI models.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.AI.Evaluation.Reporting.Storage">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains classes for storing the results of large language model (LLM) evaluations and for caching LLM responses produced during such evaluations.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.AI.Evaluation.Reporting">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains classes for generating reports based on AI evaluation metrics and for caching AI model responses.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-Microsoft.Extensions.AI.Evaluation.xml

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
<Namespace Name="Microsoft.Extensions.AI.Evaluation">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>
4+
Contains types and abstractions for evaluating AI-generated responses, including metrics, evaluators, and extensions for interpreting and processing evaluation results.
5+
</summary>
46
<remarks>To be added.</remarks>
57
</Docs>
68
</Namespace>

Diff for: xml/ns-Microsoft.Extensions.AI.xml

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
<Namespace Name="Microsoft.Extensions.AI">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>
4+
Contains types for building and managing AI-related functionality, including chat clients, embedding generators,
5+
tools, and utilities for working with AI services.
6+
</summary>
47
<remarks>To be added.</remarks>
58
</Docs>
69
</Namespace>

Diff for: xml/ns-Microsoft.Extensions.AmbientMetadata.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.AmbientMetadata">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains a class that represents an application-level metadata model.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-Microsoft.Extensions.AsyncState.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.AsyncState">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains a class that represents a registered context within the asynchronous state.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-Microsoft.Extensions.Caching.Distributed.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Caching.Distributed">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains types for distributed caching, including interfaces and implementations for caching serialized values.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-Microsoft.Extensions.Caching.Hybrid.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Caching.Hybrid">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains types for hybrid caching, combining in-memory and distributed caching strategies.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-Microsoft.Extensions.Caching.Memory.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Caching.Memory">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains types for in-memory caching, including interfaces and implementations for local caching.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-Microsoft.Extensions.Caching.SqlServer.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Caching.SqlServer">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains types for distributed caching using Microsoft SQL Server as the backend store.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Caching.StackExchangeRedis">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains types for distributed caching using Redis as the backend store.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Compliance.Classification">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains types for data classification, including attributes and utilities for classifying and managing data.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-Microsoft.Extensions.Compliance.Redaction.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Compliance.Redaction">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains types for redacting sensitive data, including redactors and related utilities.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-Microsoft.Extensions.Compliance.Testing.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Compliance.Testing">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains types for testing compliance features, including fake redactors and data classifications.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Configuration.EnvironmentVariables">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains classes for providing configuration key-value pairs from environment variables.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Configuration.KeyPerFile">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains classes for using a directory's files as configuration key-value pairs.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.DependencyInjection.Extensions">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains extension methods for adding and removing services in an <c>IServiceCollection</c>.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.DependencyInjection.Pools">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains classes and extension methods for configuring and managing object pools in the dependency injection container.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-Microsoft.Extensions.DependencyModel.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.DependencyModel">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains classes, structs, and interfaces for managing application dependencies, including compile-time and run-time library dependencies.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.DiagnosticAdapter.Infrastructure">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains interfaces for creating and managing proxy objects, including factories for run-time proxy creation and unwrappable proxy objects.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Diagnostics.Enrichment">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains classes and interfaces for enriching log records with additional properties, including options and constants for application and process enrichment.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Diagnostics.ExceptionSummarization">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains classes, structs, and interfaces for summarizing exceptions for use in telemetry, including mechanisms to register and implement exception summary providers.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Diagnostics.HealthChecks">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains classes and interfaces for configuring and managing health checks, including options for resource utilization, telemetry, and manual health status control.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-Microsoft.Extensions.Diagnostics.Latency.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Diagnostics.Latency">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains classes, structs, and interfaces for measuring and exporting latency data, including options for latency contexts, checkpoints, measures, and tags.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Diagnostics.Metrics.Configuration">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains types for retrieving and managing metrics configuration for specific listener names.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Diagnostics.Metrics.Testing">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains classes for testing metrics, including tools for collecting and working with measurements from instruments.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-Microsoft.Extensions.Diagnostics.Metrics.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Diagnostics.Metrics">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains classes, interfaces, and enums for configuring, producing, and managing metrics, including support for strongly typed metrics, instrument rules, and listener configurations.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-Microsoft.Extensions.Diagnostics.Probes.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Diagnostics.Probes">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains classes for configuring and managing health-check probes, including options for Kubernetes and TCP-based probes, and standardized health-check tags.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Diagnostics.ResourceMonitoring">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains classes, structs, and interfaces for monitoring system resources, including options for configuration, resource utilization snapshots, and publishers for resource data.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-Microsoft.Extensions.Diagnostics.Sampling.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Diagnostics.Sampling">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains classes for configuring and managing log sampling, including options and rules for random probabilistic sampling.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-Microsoft.Extensions.EnumStrings.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.EnumStrings">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains a class that provides information to guide the production of an extension method to efficiently convert an enum value into string form.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.FileProviders.Composite">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains a class that represents composite directory contents.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.FileProviders.Embedded">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains a class that represents a file embedded in an assembly.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.FileProviders.Internal">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains a class that represents the contents of a physical file directory.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.FileProviders.Physical">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Provides classes and enums for working with the physical file system.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-Microsoft.Extensions.FileProviders.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.FileProviders">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Provides abstractions and implementations for accessing file systems.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.FileSystemGlobbing.Abstractions">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains abstractions for file system entities and their wrapper implementations.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.FileSystemGlobbing.Internal.PathSegments">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains classes that support the file system globbing infrastructure. These APIs are not intended for direct use and might change in future releases.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.FileSystemGlobbing.Internal.PatternContexts">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains classes and structs that support the file system globbing infrastructure. These APIs are not intended for direct use and might change in future releases.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.FileSystemGlobbing.Internal.Patterns">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains a class that supports the file system globbing infrastructure. This API is not intended for direct use and might change in future releases.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.FileSystemGlobbing.Internal">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains classes, structs, and interfaces that support the file system globbing infrastructure. These APIs are not intended for direct use and might change in future releases.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-Microsoft.Extensions.FileSystemGlobbing.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.FileSystemGlobbing">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Provides classes and structs for file-system pattern matching.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-Microsoft.Extensions.Hosting.Testing.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Hosting.Testing">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains classes and interfaces for unit testing a host.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-Microsoft.Extensions.Http.AutoClient.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Http.AutoClient">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains classes and enums for generating REST APIs and configuring HTTP client requests.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-Microsoft.Extensions.Http.Diagnostics.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Http.Diagnostics">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains classes, interfaces, and enums for managing HTTP diagnostics, including request metadata and redaction strategies.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-Microsoft.Extensions.Http.Latency.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Extensions.Http.Latency">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains a class that provides options to configure HTTP client latency telemetry.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

0 commit comments

Comments
 (0)