From 52534500d8f66ec32893b53f97673ee672f56340 Mon Sep 17 00:00:00 2001
From: Christian Kadluba <10721825+ckadluba@users.noreply.github.com>
Date: Thu, 19 Dec 2019 19:55:32 +0100
Subject: [PATCH] Add API docs for WebSockets and Kestrel sockets transport
 #17205 (#17943)

---
 .../src/WebSocketMiddlewareExtensions.cs      | 26 ++++++++++++++++++-
 .../src/WebHostBuilderSocketExtensions.cs     |  3 +++
 2 files changed, 28 insertions(+), 1 deletion(-)

diff --git a/src/Middleware/WebSockets/src/WebSocketMiddlewareExtensions.cs b/src/Middleware/WebSockets/src/WebSocketMiddlewareExtensions.cs
index 403271f09a..4b2ce7134e 100644
--- a/src/Middleware/WebSockets/src/WebSocketMiddlewareExtensions.cs
+++ b/src/Middleware/WebSockets/src/WebSocketMiddlewareExtensions.cs
@@ -7,8 +7,20 @@ using Microsoft.Extensions.Options;
 
 namespace Microsoft.AspNetCore.Builder
 {
+    /// <summary>
+    /// <see cref="IApplicationBuilder" /> extension methods to add and configure <see cref="WebSocketMiddleware" />.
+    /// </summary>
     public static class WebSocketMiddlewareExtensions
     {
+        /// <summary>
+        /// Adds the <see cref="WebSocketMiddleware" /> to the request pipeline.
+        /// </summary>
+        /// <param name="app">
+        /// The <see cref="IApplicationBuilder" /> to configure.
+        /// </param>
+        /// <returns>
+        /// The <see cref="IApplicationBuilder" />.
+        /// </returns>
         public static IApplicationBuilder UseWebSockets(this IApplicationBuilder app)
         {
             if (app == null)
@@ -19,6 +31,18 @@ namespace Microsoft.AspNetCore.Builder
             return app.UseMiddleware<WebSocketMiddleware>();
         }
 
+        /// <summary>
+        /// Adds the <see cref="WebSocketMiddleware" /> to the request pipeline.
+        /// </summary>
+        /// <param name="app">
+        /// The <see cref="IApplicationBuilder" /> to configure.
+        /// </param>
+        /// <param name="options">
+        /// The <see cref="WebSocketOptions" /> to be used for the <see cref="WebSocketMiddleware" />.
+        /// </param>
+        /// <returns>
+        /// The <see cref="IApplicationBuilder" />.
+        /// </returns>
         public static IApplicationBuilder UseWebSockets(this IApplicationBuilder app, WebSocketOptions options)
         {
             if (app == null)
@@ -33,4 +57,4 @@ namespace Microsoft.AspNetCore.Builder
             return app.UseMiddleware<WebSocketMiddleware>(Options.Create(options));
         }
     }
-}
\ No newline at end of file
+}
diff --git a/src/Servers/Kestrel/Transport.Sockets/src/WebHostBuilderSocketExtensions.cs b/src/Servers/Kestrel/Transport.Sockets/src/WebHostBuilderSocketExtensions.cs
index d073f91aa4..8ee49f198d 100644
--- a/src/Servers/Kestrel/Transport.Sockets/src/WebHostBuilderSocketExtensions.cs
+++ b/src/Servers/Kestrel/Transport.Sockets/src/WebHostBuilderSocketExtensions.cs
@@ -8,6 +8,9 @@ using Microsoft.Extensions.DependencyInjection;
 
 namespace Microsoft.AspNetCore.Hosting
 {
+    /// <summary>
+    /// <see cref="IWebHostBuilder" /> extension methods to configure the Socket transport to be used by Kestrel.
+    /// </summary>
     public static class WebHostBuilderSocketExtensions
     {
         /// <summary>