From 356096924ee79c9669ced99438508eb5aee7a6d8 Mon Sep 17 00:00:00 2001
From: Jonathan Halterman
Date: Fri, 3 Dec 2021 19:07:54 -0800
Subject: [PATCH] Javadoc formatting fix
---
src/main/java/dev/failsafe/RateLimiter.java | 2 ++
src/main/java/dev/failsafe/RateLimiterConfig.java | 6 ++++++
src/main/java/dev/failsafe/package-info.java | 2 +-
3 files changed, 9 insertions(+), 1 deletion(-)
diff --git a/src/main/java/dev/failsafe/RateLimiter.java b/src/main/java/dev/failsafe/RateLimiter.java
index da93b529..909f3cb8 100644
--- a/src/main/java/dev/failsafe/RateLimiter.java
+++ b/src/main/java/dev/failsafe/RateLimiter.java
@@ -36,6 +36,8 @@
* {@link #tryAcquirePermit(Duration)}
* {@link #tryAcquirePermits(int, Duration)}
*
+ *
+ *
* The methods that return immediately include:
*
* - {@link #tryAcquirePermit()}
diff --git a/src/main/java/dev/failsafe/RateLimiterConfig.java b/src/main/java/dev/failsafe/RateLimiterConfig.java
index e4703833..ad3624e4 100644
--- 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 result type
+ * @author Jonathan Halterman
+ */
public class RateLimiterConfig extends PolicyConfig {
// Smoothing
Duration maxRate;
diff --git a/src/main/java/dev/failsafe/package-info.java b/src/main/java/dev/failsafe/package-info.java
index 7ae4088b..67850f2b 100644
--- 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.
*
* {@link dev.failsafe.Failsafe} is the entry point for the library. See {@link dev.failsafe.FailsafeExecutor}
* for execution options.