Javadoc formatting fix

failsafe-lib · Dec 4, 2021 · 3560969 · 3560969
1 parent e4795dc
commit 3560969
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/src/main/java/dev/failsafe/RateLimiter.java b/src/main/java/dev/failsafe/RateLimiter.java
@@ -36,6 +36,8 @@
  *   <li>{@link #tryAcquirePermit(Duration)}</li>
  *   <li>{@link #tryAcquirePermits(int, Duration)}</li>
  * </ul>
+ * </p>
+ * <p>
  * The methods that return immediately include:
  * <ul>
  *   <li>{@link #tryAcquirePermit()}</li>

diff --git a/src/main/java/dev/failsafe/RateLimiterConfig.java b/src/main/java/dev/failsafe/RateLimiterConfig.java
@@ -17,6 +17,12 @@
 
 import java.time.Duration;
 
+/**
+ * Configuration for a {@link RateLimiter}.
+ *
+ * @param <R> result type
+ * @author Jonathan Halterman
+ */
 public class RateLimiterConfig<R> extends PolicyConfig<R> {
   // Smoothing
   Duration maxRate;

diff --git a/src/main/java/dev/failsafe/package-info.java b/src/main/java/dev/failsafe/package-info.java
@@ -1,5 +1,5 @@
 /**
- * Core Failsafe APIs for performing failsafe executions.
+ * APIs for performing failsafe executions.
  * <p>
  * {@link dev.failsafe.Failsafe} is the entry point for the library. See {@link dev.failsafe.FailsafeExecutor}
  * for execution options.