xml commenting

Author: soenneker

src/Soenneker.Utils.RateLimiting.Executor/Abstract/IRateLimitingExecutor.cs

@@ -47,6 +47,12 @@ public interface IRateLimitingExecutor : IDisposable, IAsyncDisposable
     /// <returns>A task that represents the asynchronous operation and returns a result of type <typeparamref name="T"/>.</returns>
     ValueTask<T> Execute<T, TArg>(Func<CancellationToken, TArg, ValueTask<T>> valueTask, TArg argument, CancellationToken cancellationToken = default);
 
+    /// <summary>
+    /// Executes the execute task operation.
+    /// </summary>
+    /// <param name="task">The task.</param>
+    /// <param name="cancellationToken">The cancellation token.</param>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     Task ExecuteTask(Func<CancellationToken, Task> task, CancellationToken cancellationToken = default);
 
     /// <summary>
@@ -96,5 +102,8 @@ public interface IRateLimitingExecutor : IDisposable, IAsyncDisposable
     /// <param name="cancellationToken"></param>
     void Execute(Action<CancellationToken> action, CancellationToken cancellationToken = default);
 
+    /// <summary>
+    /// Executes the cancel execution operation.
+    /// </summary>
     void CancelExecution();
 }

src/Soenneker.Utils.RateLimiting.Executor/RateLimitingExecutor.Sync.cs

@@ -3,6 +3,9 @@
 
 namespace Soenneker.Utils.RateLimiting.Executor;
 
+/// <summary>
+/// Represents the rate limiting executor.
+/// </summary>
 public sealed partial class RateLimitingExecutor
 {
     private T ExecuteInternal<T>(Func<CancellationToken, T> task, CancellationToken cancellationToken)
@@ -21,12 +24,33 @@ private T ExecuteInternal<T>(Func<CancellationToken, T> task, CancellationToken
         }
     }
 
+    /// <summary>
+    /// Executes the execute operation.
+    /// </summary>
+    /// <typeparam name="T">The T type.</typeparam>
+    /// <param name="action">The action.</param>
+    /// <param name="cancellationToken">The cancellation token.</param>
+    /// <returns>The result of the operation.</returns>
     public T Execute<T>(Func<CancellationToken, T> action, CancellationToken cancellationToken = default) =>
         ExecuteInternal(action, cancellationToken);
 
+    /// <summary>
+    /// Executes the execute operation.
+    /// </summary>
+    /// <typeparam name="T">The T type.</typeparam>
+    /// <typeparam name="TArg">The TArg type.</typeparam>
+    /// <param name="action">The action.</param>
+    /// <param name="argument">The argument.</param>
+    /// <param name="cancellationToken">The cancellation token.</param>
+    /// <returns>The result of the operation.</returns>
     public T Execute<T, TArg>(Func<CancellationToken, TArg, T> action, TArg argument, CancellationToken cancellationToken = default) =>
         ExecuteInternal(token => action(token, argument), cancellationToken);
 
+    /// <summary>
+    /// Executes the execute operation.
+    /// </summary>
+    /// <param name="action">The action.</param>
+    /// <param name="cancellationToken">The cancellation token.</param>
     public void Execute(Action<CancellationToken> action, CancellationToken cancellationToken = default) =>
         ExecuteInternal(token =>
         {

src/Soenneker.Utils.RateLimiting.Executor/RateLimitingExecutor.Task.cs

@@ -6,6 +6,9 @@
 
 namespace Soenneker.Utils.RateLimiting.Executor;
 
+/// <summary>
+/// Represents the rate limiting executor.
+/// </summary>
 public sealed partial class RateLimitingExecutor
 {
     private async Task<T> ExecuteTaskInternal<T>(Func<CancellationToken, Task<T>> task, CancellationToken cancellationToken)
@@ -24,18 +27,40 @@ private async Task<T> ExecuteTaskInternal<T>(Func<CancellationToken, Task<T>> ta
         }
     }
 
+    /// <summary>
+    /// Executes the execute task operation.
+    /// </summary>
+    /// <param name="task">The task.</param>
+    /// <param name="cancellationToken">The cancellation token.</param>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     public async Task ExecuteTask(Func<CancellationToken, Task> task, CancellationToken cancellationToken = default) =>
         await ExecuteTaskInternal(async token =>
         {
             await task(token);
             return 0;
         }, cancellationToken).NoSync();
 
+    /// <summary>
+    /// Executes the execute task operation.
+    /// </summary>
+    /// <typeparam name="T">The T type.</typeparam>
+    /// <param name="task">The task.</param>
+    /// <param name="cancellationToken">The cancellation token.</param>
+    /// <returns>A task containing the result of the operation.</returns>
     public Task<T> ExecuteTask<T>(Func<CancellationToken, Task<T>> task, CancellationToken cancellationToken = default)
     {
         return ExecuteTaskInternal(task, cancellationToken);
     }
 
+    /// <summary>
+    /// Executes the execute task operation.
+    /// </summary>
+    /// <typeparam name="T">The T type.</typeparam>
+    /// <typeparam name="TArg">The TArg type.</typeparam>
+    /// <param name="task">The task.</param>
+    /// <param name="argument">The argument.</param>
+    /// <param name="cancellationToken">The cancellation token.</param>
+    /// <returns>A task containing the result of the operation.</returns>
     public Task<T> ExecuteTask<T, TArg>(Func<CancellationToken, TArg, Task<T>> task, TArg argument, CancellationToken cancellationToken = default)
     {
         return ExecuteTaskInternal(token => task(token, argument), cancellationToken);

src/Soenneker.Utils.RateLimiting.Executor/RateLimitingExecutor.cs

@@ -90,6 +90,10 @@ public void CancelExecution()
         }
     }
 
+    /// <summary>
+    /// Asynchronously releases resources used by the current instance.
+    /// </summary>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     public async ValueTask DisposeAsync()
     {
         if (_cancellationTokenSource.IsValueCreated && !_cancellationTokenSource.Value.IsCancellationRequested)
@@ -104,6 +108,9 @@ await _cancellationTokenSource.Value.CancelAsync()
         }
     }
 
+    /// <summary>
+    /// Releases resources used by the current instance.
+    /// </summary>
     public void Dispose()
     {
         if (_cancellationTokenSource.IsValueCreated && !_cancellationTokenSource.Value.IsCancellationRequested)