Merge pull request #22 from KuraiAndras/remove-unused-exceptions

Remove unused exceptions, add comments

Author: KuraiAndras

MediatR.Courier/CourierInjector.cs

@@ -4,11 +4,27 @@
 
 namespace MediatR.Courier;
 
+/// <summary>
+/// Provides extension methods for registering MediatR Courier services with the dependency injection container.
+/// </summary>
 public static class CourierInjector
 {
+    /// <summary>
+    /// Registers MediatR Courier services with the dependency injection container using default configuration.
+    /// </summary>
+    /// <param name="services">The service collection to add services to.</param>
+    /// <param name="assemblies">The assemblies to scan for notification types.</param>
+    /// <returns>The service collection for chaining.</returns>
     public static IServiceCollection AddCourier(this IServiceCollection services, params Assembly[] assemblies) =>
         services.AddCourier(_ => { }, assemblies);
 
+    /// <summary>
+    /// Registers MediatR Courier services with the dependency injection container using custom configuration.
+    /// </summary>
+    /// <param name="services">The service collection to add services to.</param>
+    /// <param name="configure">An action to configure the courier options.</param>
+    /// <param name="assemblies">The assemblies to scan for notification types.</param>
+    /// <returns>The service collection for chaining.</returns>
     public static IServiceCollection AddCourier(this IServiceCollection services, Action<CourierOptions> configure, params Assembly[] assemblies)
     {
         var options = new CourierOptions();

MediatR.Courier/CourierOptions.cs

@@ -1,6 +1,14 @@
 namespace MediatR.Courier;
 
+/// <summary>
+/// Configuration options for MediatR Courier behavior.
+/// </summary>
 public sealed class CourierOptions
 {
+    /// <summary>
+    /// Gets or sets a value indicating whether to capture the thread context when awaiting tasks.
+    /// This is used like: ConfigureAwait(CaptureThreadContext).
+    /// Defaults to false.
+    /// </summary>
     public bool CaptureThreadContext { get; set; }
 }

MediatR.Courier/Exceptions/MethodNotImplementedException.cs

@@ -1,40 +1,88 @@
 namespace MediatR.Courier;
 
+/// <summary>
+/// Provides functionality for subscribing to and unsubscribing from MediatR notifications
+/// with support for both strong and weak reference handlers.
+/// </summary>
 public interface ICourier
 {
+    /// <summary>
+    /// Subscribes a handler to receive notifications of the specified type.
+    /// The handler will be held with a strong reference.
+    /// </summary>
+    /// <typeparam name="TNotification">The type of notification to subscribe to.</typeparam>
+    /// <param name="handler">The handler to invoke when a notification is published.</param>
     void Subscribe<TNotification>(Action<TNotification> handler)
         where TNotification : INotification;
 
+    /// <inheritdoc cref="Subscribe{TNotification}(Action{TNotification})"/>
+    /// <typeparam name="TNotification">The type of notification to subscribe to.</typeparam>
+    /// <param name="handler">The handler to invoke when a notification is published.</param>
     void Subscribe<TNotification>(Action<TNotification, CancellationToken> handler)
         where TNotification : INotification;
 
+    /// <inheritdoc cref="Subscribe{TNotification}(Action{TNotification})"/>
+    /// <typeparam name="TNotification">The type of notification to subscribe to.</typeparam>
+    /// <param name="handler">The handler to invoke when a notification is published.</param>
     void Subscribe<TNotification>(Func<TNotification, Task> handler)
         where TNotification : INotification;
 
+    /// <inheritdoc cref="Subscribe{TNotification}(Action{TNotification})"/>
+    /// <typeparam name="TNotification">The type of notification to subscribe to.</typeparam>
+    /// <param name="handler">The handler to invoke when a notification is published.</param>
     void Subscribe<TNotification>(Func<TNotification, CancellationToken, Task> handler)
         where TNotification : INotification;
 
+    /// <summary>
+    /// Subscribes a handler to receive notifications of the specified type using a weak reference.
+    /// The handler will be held with a weak reference, allowing the target object to be garbage collected.
+    /// </summary>
+    /// <typeparam name="TNotification">The type of notification to subscribe to.</typeparam>
+    /// <param name="handler">The handler to invoke when a notification is published.</param>
     void SubscribeWeak<TNotification>(Action<TNotification> handler)
         where TNotification : INotification;
 
+    /// <inheritdoc cref="SubscribeWeak{TNotification}(Action{TNotification})"/>
+    /// <typeparam name="TNotification">The type of notification to subscribe to.</typeparam>
+    /// <param name="handler">The handler to invoke when a notification is published.</param>
     void SubscribeWeak<TNotification>(Action<TNotification, CancellationToken> handler)
         where TNotification : INotification;
 
+    /// <inheritdoc cref="SubscribeWeak{TNotification}(Action{TNotification})"/>
+    /// <typeparam name="TNotification">The type of notification to subscribe to.</typeparam>
+    /// <param name="handler">The handler to invoke when a notification is published.</param>
     void SubscribeWeak<TNotification>(Func<TNotification, Task> handler)
         where TNotification : INotification;
 
+    /// <inheritdoc cref="SubscribeWeak{TNotification}(Action{TNotification})"/>
+    /// <typeparam name="TNotification">The type of notification to subscribe to.</typeparam>
+    /// <param name="handler">The handler to invoke when a notification is published.</param>
     void SubscribeWeak<TNotification>(Func<TNotification, CancellationToken, Task> handler)
         where TNotification : INotification;
 
+    /// <summary>
+    /// Unsubscribes a handler from receiving notifications of the specified type.
+    /// </summary>
+    /// <typeparam name="TNotification">The type of notification to unsubscribe from.</typeparam>
+    /// <param name="handler">The handler to remove from the subscription list.</param>
     void UnSubscribe<TNotification>(Action<TNotification> handler)
         where TNotification : INotification;
 
+    /// <inheritdoc cref="UnSubscribe{TNotification}(Action{TNotification})"/>
+    /// <typeparam name="TNotification">The type of notification to unsubscribe from.</typeparam>
+    /// <param name="handler">The handler to remove from the subscription list.</param>
     void UnSubscribe<TNotification>(Action<TNotification, CancellationToken> handler)
         where TNotification : INotification;
 
+    /// <inheritdoc cref="UnSubscribe{TNotification}(Action{TNotification})"/>
+    /// <typeparam name="TNotification">The type of notification to unsubscribe from.</typeparam>
+    /// <param name="handler">The handler to remove from the subscription list.</param>
     void UnSubscribe<TNotification>(Func<TNotification, Task> handler)
         where TNotification : INotification;
 
+    /// <inheritdoc cref="UnSubscribe{TNotification}(Action{TNotification})"/>
+    /// <typeparam name="TNotification">The type of notification to unsubscribe from.</typeparam>
+    /// <param name="handler">The handler to remove from the subscription list.</param>
     void UnSubscribe<TNotification>(Func<TNotification, CancellationToken, Task> handler)
         where TNotification : INotification;
 }