Added xml comments to OutboxSweeper

src/Paramore.Brighter.Extensions.Hosting/TimedOutboxSweeper.cs

@@ -41,7 +41,7 @@ private void DoWork(object state)
                 IAmACommandProcessor commandProcessor = scope.ServiceProvider.GetService<IAmACommandProcessor>();
 
                 var outBoxSweeper = new OutboxSweeper(
-                    milliSecondsSinceSent: _options.MinimumMessageAge,
+                    millisecondsSinceSent: _options.MinimumMessageAge,
                     commandProcessor: commandProcessor,
                     _options.BatchSize,
                     _options.UseBulk);

src/Paramore.Brighter/OutboxSweeper.cs

@@ -1,48 +1,42 @@
-using System;
-using System.Linq;
-using System.Threading;
-using System.Threading.Tasks;
-
-namespace Paramore.Brighter
+namespace Paramore.Brighter
 {
     public class OutboxSweeper
     {
-        private readonly int _milliSecondsSinceSent;
+        private readonly int _millisecondsSinceSent;
         private readonly IAmACommandProcessor _commandProcessor;
         private readonly int _batchSize;
         private readonly bool _useBulk;
 
         /// <summary>
         /// This sweeper clears an outbox of any outstanding messages within the time interval
         /// </summary>
-        /// <param name="milliSecondsSinceSent">How long can a message sit in the box before we attempt to resend</param>
+        /// <param name="millisecondsSinceSent">How long can a message sit in the box before we attempt to resend</param>
         /// <param name="commandProcessor">Who should post the messages</param>
         /// <param name="batchSize">The maximum number of messages to dispatch.</param>
         /// <param name="useBulk">Use the producers bulk dispatch functionality.</param>
-        public OutboxSweeper(int milliSecondsSinceSent, IAmACommandProcessor commandProcessor, int batchSize = 100,
+        public OutboxSweeper(int millisecondsSinceSent, IAmACommandProcessor commandProcessor, int batchSize = 100,
             bool useBulk = false)
         {
-            _milliSecondsSinceSent = milliSecondsSinceSent;
+            _millisecondsSinceSent = millisecondsSinceSent;
             _commandProcessor = commandProcessor;
             _batchSize = batchSize;
             _useBulk = useBulk;
         }
 
+        /// <summary>
+        /// Dispatches the oldest un-dispatched messages from the outbox in a background thread.
+        /// </summary>
         public void Sweep()
         {
-            _commandProcessor.ClearOutbox(_batchSize, _milliSecondsSinceSent);
-        }
-
-        public Task SweepAsync(CancellationToken cancellationToken = default)
-        {
-            _commandProcessor.ClearAsyncOutbox(_batchSize, _milliSecondsSinceSent, _useBulk);
-
-            return Task.CompletedTask;
+            _commandProcessor.ClearOutbox(_batchSize, _millisecondsSinceSent);
         }
 
+        /// <summary>
+        /// Dispatches the oldest un-dispatched messages from the asynchronous outbox in a background thread.
+        /// </summary>
         public void SweepAsyncOutbox()
         {
-            _commandProcessor.ClearAsyncOutbox(_batchSize, _milliSecondsSinceSent, _useBulk);
+            _commandProcessor.ClearAsyncOutbox(_batchSize, _millisecondsSinceSent, _useBulk);
         }
     }
 }