Small javadoc improvement to CircuitBreaker

jhalterman · jhalterman · commit ab32c5424acc · 2022-09-28T08:31:40.000-07:00
diff --git a/core/src/main/java/dev/failsafe/CircuitBreaker.java b/core/src/main/java/dev/failsafe/CircuitBreaker.java
@@ -75,9 +75,9 @@ static <R> CircuitBreakerBuilder<R> builder(CircuitBreakerConfig<R> config) {
   }
 
   /**
-   * Creates a count based CircuitBreaker that opens after a {@link CircuitBreakerBuilder#withFailureThreshold(int)
-   * single failure}, closes after a {@link CircuitBreakerBuilder#withSuccessThreshold(int) single success}, and has a 1
-   * minute {@link CircuitBreakerBuilder#withDelay(Duration) delay} by default. To configure additional options on a
+   * Creates a count based CircuitBreaker that opens after one {@link CircuitBreakerBuilder#withFailureThreshold(int)
+   * failure}, half-opens after a one minute {@link CircuitBreakerBuilder#withDelay(Duration) delay}, and closes after one
+   * {@link CircuitBreakerBuilder#withSuccessThreshold(int) success}. To configure additional options on a
    * CircuitBreaker, use {@link #builder()} instead.
    *
    * @see #builder()

Original file line number	Diff line number	Diff line change
`@@ -75,9 +75,9 @@ static <R> CircuitBreakerBuilder<R> builder(CircuitBreakerConfig<R> config) {`
`75`	`75`	`}`
`76`	`76`
`77`	`77`	`/**`
`78`		`- * Creates a count based CircuitBreaker that opens after a {@link CircuitBreakerBuilder#withFailureThreshold(int)`
`79`		`- * single failure}, closes after a {@link CircuitBreakerBuilder#withSuccessThreshold(int) single success}, and has a 1`
`80`		`- * minute {@link CircuitBreakerBuilder#withDelay(Duration) delay} by default. To configure additional options on a`
	`78`	`+ * Creates a count based CircuitBreaker that opens after one {@link CircuitBreakerBuilder#withFailureThreshold(int)`
	`79`	`+ * failure}, half-opens after a one minute {@link CircuitBreakerBuilder#withDelay(Duration) delay}, and closes after one`
	`80`	`+ * {@link CircuitBreakerBuilder#withSuccessThreshold(int) success}. To configure additional options on a`
`81`	`81`	`* CircuitBreaker, use {@link #builder()} instead.`
`82`	`82`	`*`
`83`	`83`	`* @see #builder()`