Skip to content

Commit 60b48d6

Browse files
authored
Add namespace summaries for System* namespaces (#11138)
1 parent 1c48e3a commit 60b48d6

30 files changed

+32
-71
lines changed

Diff for: xml/ns-System.Cloud.DocumentDb.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="System.Cloud.DocumentDb">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Provides types and interfaces for managing document-oriented (NoSQL) databases, including database configuration, query execution, transactional operations, and exception handling. </summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-System.Cloud.Messaging.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="System.Cloud.Messaging">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Provides types and extension methods for building and managing asynchronous message processing pipelines.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-System.Collections.Frozen.xml

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
<Namespace Name="System.Collections.Frozen">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>
4+
Contains types that provide immutable, read-only collections optimized for fast lookup and enumeration.
5+
</summary>
46
<remarks>To be added.</remarks>
57
</Docs>
68
</Namespace>

Diff for: xml/ns-System.CommandLine.Binding.xml

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
<Namespace Name="System.CommandLine.Binding">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>
4+
Provides types for binding command-line input to objects, including support for custom types,
5+
binding contexts, and value descriptors.
6+
</summary>
47
<remarks>To be added.</remarks>
58
</Docs>
69
</Namespace>

Diff for: xml/ns-System.CommandLine.Builder.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="System.CommandLine.Builder">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Provides classes and extension methods for building and configuring command-line applications.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-System.CommandLine.Completions.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="System.CommandLine.Completions">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Provides types and interfaces for command-line completion operations, including contexts, items, and sources for generating completions.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-System.CommandLine.Help.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="System.CommandLine.Help">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Provides types and methods for formatting and displaying command-line help.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-System.CommandLine.IO.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="System.CommandLine.IO">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Provides types for working with standard input, output, and error streams, including in-memory and console-based implementations.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-System.CommandLine.Invocation.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="System.CommandLine.Invocation">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Provides types for handling command invocation, including context, handlers, results, middleware, and middleware ordering.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-System.CommandLine.Parsing.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="System.CommandLine.Parsing">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Provides types and methods for parsing command-line input, including arguments, options, commands, and tokens.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-System.CommandLine.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="System.CommandLine">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Provides types for defining commands, options, arguments, and their relationships in command-line applications.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-System.Data.Sql.xml

+1-5
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,7 @@
44
<remarks>
55
<format type="text/markdown"><![CDATA[
66
7-
## Remarks
8-
For information about the functionality that the classes within this namespace support, see [Enumerating Instances of SQL Server (ADO.NET)](/dotnet/framework/data/adonet/sql/enumerating-instances-of-sql-server) and [Query Notifications in SQL Server](/dotnet/framework/data/adonet/sql/query-notifications-in-sql-server).
9-
10-
> [!NOTE]
11-
> In beta releases of ADO.NET version 2.0, the <xref:System.Data.Sql> namespace also contained classes for use with SQL Server common language runtime (CLR) integration. However, those classes have been moved into their own namespace, <xref:Microsoft.SqlServer.Server>. For more information about using SQL Server CLR integration, see [SQL Server Common Language Runtime Integration](/dotnet/framework/data/adonet/sql/sql-server-common-language-runtime-integration).
7+
For information about the functionality of the classes within this namespace, see [Enumerating Instances of SQL Server (ADO.NET)](/dotnet/framework/data/adonet/sql/enumerating-instances-of-sql-server) and [Query Notifications in SQL Server](/dotnet/framework/data/adonet/sql/query-notifications-in-sql-server).
128
139
]]></format>
1410
</remarks>

Diff for: xml/ns-System.Drawing.Design.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
The classes in this namespace can be used to create custom toolbox items, type-specific value editors that can edit and graphically represent values of their supported types, and type converters that can convert values between certain types. This namespace provides the basic frameworks for developing extensions to the design-time UI.
99
1010
> [!CAUTION]
11-
> Classes within the <xref:System.Drawing.Design> namespace are not supported for use within a Windows or ASP.NET service. Attempting to use these classes from within one of these application types may produce unexpected problems, such as diminished service performance and run-time exceptions.
11+
> Classes within the <xref:System.Drawing.Design> namespace are not supported for use within a Windows or ASP.NET service. Attempting to use these classes from within one of these application types might produce unexpected problems, such as diminished service performance and run-time exceptions.
1212
1313
]]></format>
1414
</remarks>

Diff for: xml/ns-System.Formats.Nrbf.xml

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
<Namespace Name="System.Formats.Nrbf">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>
4+
Provides classes and utilities for working with .NET Remoting Binary Format (NRBF) encoded data,
5+
including support for decoding payloads, handling serialization records, and managing array and class records.
6+
</summary>
47
<remarks>To be added.</remarks>
58
</Docs>
69
</Namespace>

Diff for: xml/ns-System.Globalization.xml

-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
The following blogs include discussions of the <xref:System.Globalization> namespace and its classes:
1010
1111
- <https://learn.microsoft.com/archive/blogs/shawnste/>
12-
1312
- <https://learn.microsoft.com/archive/blogs/kierans/>
1413
1514
Two of the .NET types in this namespace, <xref:System.Globalization.CultureAndRegionInfoBuilder> and <xref:System.Globalization.CultureAndRegionModifiers>, are found in an assembly named *sysglobl.dll*. To successfully compile code that uses these types, add a reference to sysglobl.dll.

Diff for: xml/ns-System.Net.Http.xml

-1
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,5 @@ If your app uses the <xref:System.Net.Http> and <xref:System.Net.Http.Headers> n
4444
]]></format>
4545
</remarks>
4646
<altmember cref="N:System.Net.Http.Headers" />
47-
<related type="Article" href="https://learn.microsoft.com/previous-versions/windows/apps/hh761504(v=win.10)">Connecting to a web service</related>
4847
</Docs>
4948
</Namespace>

Diff for: xml/ns-System.Net.ServerSentEvents.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="System.Net.ServerSentEvents">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Provides classes and delegates for working with server-sent events, including formatting, parsing, and representing event data.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-System.Numerics.Tensors.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="System.Numerics.Tensors">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Provides types and methods for tensor operations and memory management.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-System.Runtime.Diagnostics.xml

-6
This file was deleted.

Diff for: xml/ns-System.Runtime.Intrinsics.Arm.Arm64.xml

-6
This file was deleted.

Diff for: xml/ns-System.Runtime.Intrinsics.Arm.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="System.Runtime.Intrinsics.Arm">
22
<Docs>
3-
<summary>Exposes select instruction-set extensions for ARM systems. These instruction sets are expressed as separate classes for each extension. Support for any extension within the current environment can be determined by querying the <see langword="IsSupported" /> property on the respective type.</summary>
3+
<summary>Exposes select instruction-set extensions for ARM systems. These instruction sets are expressed as separate classes for each extension. You can determine support for any extension within the current environment by querying the <see langword="IsSupported" /> property on the respective type.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-System.Runtime.Loader.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="System.Runtime.Loader">
22
<Docs>
3-
<summary>Provides interfaces and classes to allow developers the opportunity to influence runtime loading behavior.</summary>
3+
<summary>Provides interfaces and classes to influence runtime loading behavior.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-System.Runtime.Remoting.Channels.Smtp.xml

-6
This file was deleted.

Diff for: xml/ns-System.Runtime.xml

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
<Namespace Name="System.Runtime">
22
<Docs>
3-
<summary>Contains advanced types that support diverse namespaces such as the <see langword="System" />, <see langword="Runtime" />, and the <see langword="Security" /> namespaces.</summary>
3+
<summary>Contains advanced types that support diverse namespaces such as the <see langword="System" />, <see langword="Runtime" />, and <see langword="Security" /> namespaces.</summary>
44
<remarks>
55
<format type="text/markdown"><![CDATA[
66
7-
## Remarks
8-
The types found in this namespace are intended for use in advanced development.
7+
The types found in this namespace are intended for use in advanced development.
98
109
]]></format>
1110
</remarks>

Diff for: xml/ns-System.Text.Json.Schema.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="System.Text.Json.Schema">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Provides functionality for generating JSON schema objects from .NET types using metadata and context.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

Diff for: xml/ns-System.Text.Json.Serialization.Metadata.xml

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
<Namespace Name="System.Text.Json.Serialization.Metadata">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>
4+
Contains classes, structs, and interfaces that provide metadata and configuration for JSON serialization and deserialization in System.Text.Json.
5+
</summary>
46
<remarks>To be added.</remarks>
57
</Docs>
68
</Namespace>

Diff for: xml/ns-System.Text.Json.SourceGeneration.xml

-6
This file was deleted.

Diff for: xml/ns-System.Web.UI.MobileControls.ShippedAdapterSource.xml

-6
This file was deleted.

Diff for: xml/ns-System.Windows.Forms.Analyzers.xml

-6
This file was deleted.

Diff for: xml/ns-System.Windows.Forms.Design.Resources.xml

-6
This file was deleted.

0 commit comments

Comments
 (0)