Various bits of documentation

Author: ascott18

src/IntelliTect.AspNetCore.SignalR.SqlServer/IntelliTect.AspNetCore.SignalR.SqlServer.csproj

@@ -4,6 +4,7 @@
 		<TargetFrameworks>netstandard2.0;netcoreapp3.1;net5.0</TargetFrameworks>
 		<LangVersion>9.0</LangVersion>
 		<Nullable>enable</Nullable>
+		<GenerateDocumentationFile>true</GenerateDocumentationFile>
 
 		<RepositoryUrl>https://github.com/IntelliTect/IntelliTect.AspNetCore.SignalR.SqlServer</RepositoryUrl>
 		<RepositoryType>git</RepositoryType>
@@ -20,7 +21,7 @@
 	</PropertyGroup>
 
 	<ItemGroup>
-		<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All"/>
+		<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All" />
 
 		<PackageReference Include="MessagePack" Version="2.3.75" />
 		<PackageReference Include="Microsoft.Data.SqlClient" Version="3.0.0" />

src/IntelliTect.AspNetCore.SignalR.SqlServer/Internal/SqlServer/SqlReceiver.cs

@@ -364,15 +364,15 @@ private bool StartSqlDependencyListener()
             }
             catch (InvalidOperationException)
             {
-                _logger.LogWarning("{0}SQL Service Broker is disabled. Falling back on periodic polling.", _tracePrefix);
+                _logger.LogWarning("{0}SQL Service Broker is disabled on the target database.", _tracePrefix);
                 _notificationsDisabled = true;
                 return false;
             }
             catch (NullReferenceException)
             {
                 // Workaround for https://github.com/dotnet/SqlClient/issues/1264
 
-                _logger.LogWarning("{0}SQL Service Broker is disabled. Falling back on periodic polling.", _tracePrefix);
+                _logger.LogWarning("{0}SQL Service Broker is disabled or unsupported by the target database.", _tracePrefix);
                 _notificationsDisabled = true;
                 return false;
             }
@@ -382,7 +382,7 @@ private bool StartSqlDependencyListener()
                 // Specifically that Azure SQL Database reports that service broker is enabled,
                 // even though it is entirely unsupported.
 
-                _logger.LogWarning("{0}SQL Service Broker is unsupported by the target database. Falling back on periodic polling.", _tracePrefix);
+                _logger.LogWarning("{0}SQL Service Broker is unsupported by the target database.", _tracePrefix);
                 _notificationsDisabled = true;
                 return false;
             }

src/IntelliTect.AspNetCore.SignalR.SqlServer/SqlServerHubLifetimeManager.cs

@@ -362,6 +362,7 @@ private async Task SendGroupActionAndWaitForAck(string connectionId, string grou
             await ack;
         }
 
+        /// <inheritdoc/>
         public void Dispose()
         {
             _disposed = true;

src/IntelliTect.AspNetCore.SignalR.SqlServer/SqlServerMessageMode.cs

@@ -9,12 +9,25 @@
 
 namespace IntelliTect.AspNetCore.SignalR.SqlServer
 {
-
+    /// <summary>
+    /// Specifies the allowed modes of acquiring scaleout messages from SQL Server.
+    /// </summary>
+    [Flags]
     public enum SqlServerMessageMode
     {
+        /// <summary>
+        /// Use SQL Server Service Broker for dicovering when new messages are available.
+        /// </summary>
         ServiceBroker = 1 << 0,
+
+        /// <summary>
+        /// Use perioid polling to discover when new messages are available.
+        /// </summary>
         Polling = 1 << 1,
 
+        /// <summary>
+        /// Use the most suitable mode for acquring messages.
+        /// </summary>
         Auto = ServiceBroker | Polling,
     }
 }

src/IntelliTect.AspNetCore.SignalR.SqlServer/SqlServerOptions.cs

@@ -46,6 +46,9 @@ public class SqlServerOptions
         /// </summary>
         public bool AutoEnableServiceBroker { get; set; } = false;
 
+        /// <summary>
+        /// Flag enum that specifies the allowed modes for retrieving messages from SQL Server. Default Auto.
+        /// </summary>
         public SqlServerMessageMode Mode { get; set; } = SqlServerMessageMode.Auto;
     }
 }