Javadoc improvements

failsafe-lib · Jan 31, 2023 · be89177 · be89177
1 parent ab32c54
commit be89177
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/core/src/main/java/dev/failsafe/CircuitBreaker.java b/core/src/main/java/dev/failsafe/CircuitBreaker.java
@@ -229,7 +229,7 @@ default void acquirePermit() {
   void recordFailure();
 
   /**
-   * Records an {@code exception} as a success or failure based on the exception configuration.
+   * Records an {@code exception} as a success or failure based on the failure configuration.
    */
   void recordException(Throwable exception);
 

diff --git a/core/src/main/java/dev/failsafe/ExecutionImpl.java b/core/src/main/java/dev/failsafe/ExecutionImpl.java
@@ -169,7 +169,7 @@ synchronized ExecutionResult<R> postExecute(ExecutionResult<R> result) {
     return result;
   }
 
-  /** Called indorectly by users. */
+  /** Called indirectly by users. */
   @Override
   public boolean cancel() {
     boolean cancelled = isCancelled();

diff --git a/core/src/main/java/dev/failsafe/internal/util/DelegatingScheduler.java b/core/src/main/java/dev/failsafe/internal/util/DelegatingScheduler.java
@@ -21,12 +21,12 @@
 
 /**
  * A {@link Scheduler} implementation that schedules delays on an internal, common ScheduledExecutorService and executes
- * tasks on either a provided ExecutorService, {@link ForkJoinPool#commonPool()}, or an internal {@link ForkJoinPool}
- * instance. If no {@link ExecutorService} is supplied, the {@link ForkJoinPool#commonPool()} will be used, unless the
- * common pool's parallelism is 1, then an internal {@link ForkJoinPool} with parallelism of 2 will be created and
- * used.
+ * tasks on either a provided {@link ExecutorService}, {@link ForkJoinPool#commonPool()}, or an internal
+ * {@link ForkJoinPool} instance. If no {@link ExecutorService} is supplied, the {@link ForkJoinPool#commonPool()} will
+ * be used, unless the common pool's parallelism is 1, then an internal {@link ForkJoinPool} with parallelism of 2 will
+ * be created and used.
  * <p>
- * Supports cancellation of {@link ForkJoinPool} tasks.
+ * Supports cancellation and interruption of {@link ForkJoinPool} tasks.
  * </p>
  *
  * @author Jonathan Halterman