Added XML comments to public interfaces

Changed accessors for classes
Added coding rules for uninstantiated classes
Exposed internal classes to Test assembly

Author: Anders Tøgersen (Delegate)

.editorconfig

@@ -506,4 +506,5 @@ dotnet_diagnostic.S1135.severity = suggestion       # https://github.com/atc-net
 dotnet_diagnostic.CA1062.severity = none            # Do not demand null-checking when using nullable reference types.
 dotnet_diagnostic.SA1011.severity = none            # Space needed after closing square bracet "]" needed for nullable arrays
 dotnet_diagnostic.SA1401.severity = none			# Field should be private
-dotnet_diagnostic.CA1051.severity = none			# Do not declare visible instance fields
+dotnet_diagnostic.CA1051.severity = none			# Do not declare visible instance fields
+dotnet_diagnostic.CA1812.severity = none			# Internal classes are instantiated by IoC

sample/SampleApi/Program.cs

@@ -12,7 +12,8 @@
 builder.Services.AddSingleton<SendDataHandler>();
 
 // Register Atc.Azure.Messaging dependencies
-builder.Services.ConfigureMessagingServices(builder.Configuration); // ConfigureMessagingServices(builder.Configuration, true)
+var useManagedIdentity = false;
+builder.Services.ConfigureMessagingServices(builder.Configuration, useManagedIdentity);
 
 var app = builder.Build();
 app.UseHttpsRedirection();

src/Atc.Azure.Messaging/EventHub/EventHubCredentialsPublisherFactory.cs

@@ -12,7 +12,7 @@ namespace Atc.Azure.Messaging.EventHub;
     "Reliability",
     "CA2000:Dispose objects before losing scope",
     Justification = "EventHubPublisher is responsible for disposing EventHubProducerClient")]
-public class EventHubCredentialsPublisherFactory : IEventHubPublisherFactory
+internal sealed class EventHubCredentialsPublisherFactory : IEventHubPublisherFactory
 {
     private readonly string fullyQualifiedNamespace;
     private readonly DefaultAzureCredentialOptions credentialOptions;

src/Atc.Azure.Messaging/EventHub/EventHubPublisher.cs

@@ -5,7 +5,7 @@
 
 namespace Atc.Azure.Messaging.EventHub;
 
-public sealed class EventHubPublisher : IEventHubPublisher
+internal sealed class EventHubPublisher : IEventHubPublisher
 {
     private readonly EventHubProducerClient client;
 

src/Atc.Azure.Messaging/EventHub/EventHubPublisherFactory.cs

@@ -1,11 +1,14 @@
+using System.Diagnostics.CodeAnalysis;
 using Atc.Azure.Options.EventHub;
 using Azure.Messaging.EventHubs.Producer;
 
 namespace Atc.Azure.Messaging.EventHub;
 
-#pragma warning disable CA2000 // Dispose objects before losing scope
-
-public class EventHubPublisherFactory : IEventHubPublisherFactory
+[SuppressMessage(
+    "Reliability",
+    "CA2000:Dispose objects before losing scope",
+    Justification = "EventHubPublisher is responsible for disposing EventHubProducerClient")]
+internal sealed class EventHubPublisherFactory : IEventHubPublisherFactory
 {
     private readonly string connectionString;
 

src/Atc.Azure.Messaging/EventHub/IEventHubPublisher.cs

@@ -1,5 +1,11 @@
-namespace Atc.Azure.Messaging.EventHub;
+namespace Atc.Azure.Messaging.EventHub;
 
+/// <summary>
+/// Publisher responsible for publishing objects with metadata to a specific EventHub.
+/// </summary>
+/// <remarks>
+/// Is safe to cache and use in singletons for the lifetime of the application.
+/// </remarks>
 public interface IEventHubPublisher : IAsyncDisposable
 {
     Task PublishAsync(

src/Atc.Azure.Messaging/EventHub/IEventHubPublisherFactory.cs

@@ -1,5 +1,8 @@
 namespace Atc.Azure.Messaging.EventHub;
 
+/// <summary>
+/// Factory responsible for creating <see cref="IEventHubPublisher"/>s for a specific EventHub namespace.
+/// </summary>
 public interface IEventHubPublisherFactory
 {
     IEventHubPublisher Create(string eventHubName);

src/Atc.Azure.Messaging/ServiceBus/IServiceBusClientFactory.cs

@@ -1,8 +1,8 @@
-using Azure.Messaging.ServiceBus;
+using Azure.Messaging.ServiceBus;
 
 namespace Atc.Azure.Messaging.ServiceBus;
 
-public interface IServiceBusClientFactory
+internal interface IServiceBusClientFactory
 {
     ServiceBusClient Create();
 }

src/Atc.Azure.Messaging/ServiceBus/IServiceBusPublisher.cs

@@ -1,5 +1,8 @@
 namespace Atc.Azure.Messaging.ServiceBus;
 
+/// <summary>
+/// Publisher responsible for publishing objects with metadata to a specific ServiceBus.
+/// </summary>
 public interface IServiceBusPublisher
 {
     Task PublishAsync(

src/Atc.Azure.Messaging/ServiceBus/IServiceBusSenderProvider.cs

@@ -2,7 +2,7 @@
 
 namespace Atc.Azure.Messaging.ServiceBus;
 
-public interface IServiceBusSenderProvider
+internal interface IServiceBusSenderProvider
 {
     ServiceBusSender GetSender(string topicName);
 }