Add missing API docs to RateLimiting (#87627)

dotnet · Jun 15, 2023 · 73e4061 · 73e4061
1 parent 35996db
commit 73e4061
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 0 deletions.
diff --git a/...ies/System.Threading.RateLimiting/src/System/Threading/RateLimiting/ConcurrencyLimiter.cs b/...ies/System.Threading.RateLimiting/src/System/Threading/RateLimiting/ConcurrencyLimiter.cs
@@ -295,6 +295,7 @@ private void Release(int releaseCount)
             }
         }
 
+        /// <inheritdoc/>
         protected override void Dispose(bool disposing)
         {
             if (!disposing)
@@ -320,6 +321,7 @@ protected override void Dispose(bool disposing)
             }
         }
 
+        /// <inheritdoc/>
         protected override ValueTask DisposeAsyncCore()
         {
             Dispose(true);

diff --git a/...System.Threading.RateLimiting/src/System/Threading/RateLimiting/FixedWindowRateLimiter.cs b/...System.Threading.RateLimiting/src/System/Threading/RateLimiting/FixedWindowRateLimiter.cs
@@ -365,6 +365,7 @@ private void ReplenishInternal(long nowTicks)
             }
         }
 
+        /// <inheritdoc />
         protected override void Dispose(bool disposing)
         {
             if (!disposing)
@@ -391,6 +392,7 @@ protected override void Dispose(bool disposing)
             }
         }
 
+        /// <inheritdoc />
         protected override ValueTask DisposeAsyncCore()
         {
             Dispose(true);

diff --git a/...ystem.Threading.RateLimiting/src/System/Threading/RateLimiting/ReplenishingRateLimiter.cs b/...ystem.Threading.RateLimiting/src/System/Threading/RateLimiting/ReplenishingRateLimiter.cs
@@ -3,6 +3,9 @@
 
 namespace System.Threading.RateLimiting
 {
+    /// <summary>
+    /// Abstraction that specifies that the <see cref="RateLimiter"/> implementation is capable of replenishing tokens.
+    /// </summary>
     public abstract class ReplenishingRateLimiter : RateLimiter
     {
         /// <summary>

diff --git a/...stem.Threading.RateLimiting/src/System/Threading/RateLimiting/SlidingWindowRateLimiter.cs b/...stem.Threading.RateLimiting/src/System/Threading/RateLimiting/SlidingWindowRateLimiter.cs
@@ -378,6 +378,7 @@ private void ReplenishInternal(long nowTicks)
             }
         }
 
+        /// <inheritdoc />
         protected override void Dispose(bool disposing)
         {
             if (!disposing)
@@ -404,6 +405,7 @@ protected override void Dispose(bool disposing)
             }
         }
 
+        /// <inheritdoc />
         protected override ValueTask DisposeAsyncCore()
         {
             Dispose(true);

diff --git a/...System.Threading.RateLimiting/src/System/Threading/RateLimiting/TokenBucketRateLimiter.cs b/...System.Threading.RateLimiting/src/System/Threading/RateLimiting/TokenBucketRateLimiter.cs
@@ -380,6 +380,7 @@ private void ReplenishInternal(long nowTicks)
             }
         }
 
+        /// <inheritdoc />
         protected override void Dispose(bool disposing)
         {
             if (!disposing)
@@ -406,6 +407,7 @@ protected override void Dispose(bool disposing)
             }
         }
 
+        /// <inheritdoc />
         protected override ValueTask DisposeAsyncCore()
         {
             Dispose(true);