diff --git a/src/main/java/io/earcam/unexceptional/CheckedComparator.java b/src/main/java/io/earcam/unexceptional/CheckedComparator.java index a2f4ee9..240f11d 100644 --- a/src/main/java/io/earcam/unexceptional/CheckedComparator.java +++ b/src/main/java/io/earcam/unexceptional/CheckedComparator.java @@ -166,8 +166,6 @@ public default CheckedComparator thenComparingDouble(CheckedToDoubleFunction< /** * See {@link java.util.Comparator#comparing(java.util.function.Function, Comparator)} * - * @return the chained {@link CheckedComparator} - * * @param the type of element to be compared * @param the type of the sort key * diff --git a/src/main/java/io/earcam/unexceptional/CheckedFunction.java b/src/main/java/io/earcam/unexceptional/CheckedFunction.java index f504cf9..0f09bc7 100644 --- a/src/main/java/io/earcam/unexceptional/CheckedFunction.java +++ b/src/main/java/io/earcam/unexceptional/CheckedFunction.java @@ -86,7 +86,8 @@ public default CheckedFunction andThen(CheckedFunction argument and return type * @return the argument as given * * @since 0.3.0 diff --git a/src/main/java/io/earcam/unexceptional/Closing.java b/src/main/java/io/earcam/unexceptional/Closing.java index b495baa..e598e29 100644 --- a/src/main/java/io/earcam/unexceptional/Closing.java +++ b/src/main/java/io/earcam/unexceptional/Closing.java @@ -27,7 +27,7 @@ /** *

* Succinctly handle {@link AutoCloseable}s that throw checked {@link Exception}s. - *

+ *

* *

* There are two families of static methods; {@code closeAfterApplying(...)} and {@code closeAfterAccepting(...)}, the @@ -36,9 +36,6 @@ *

* *

- *

- * - *

* Example: this zero-branch, single-instruction, one-liner will find a free port number: *

* @@ -49,6 +46,7 @@ *

* Motivation: I/O stream instances typically (and necessarily) requires handling a lot of possible * {@link IOException}s - by invoking: + *

*
    *
  • Constructor
  • *
  • A read/write call
  • @@ -56,7 +54,7 @@ *
  • A read/write call, then subsequently in the call to {@link AutoCloseable#close()} - via * {@code try}-with-resources
  • *
- *

+ * *

* That's a lot of branches to cover - often it is irrelevant to the application which branch actually throws, but * regardless test coverage suffers without some needless stub/mocked throw-on-create/read/write/close tests. @@ -117,8 +115,8 @@ public static R closeAfterApplying(@WillClose C clo /** * Applies the bi-function to the closeable, returning the result and closing the closable - checked exceptions are * rethrown as unchecked. - * @param closeable the closeable subject of the {@code convert} function - * @param instance + * @param closeable the closeable subject of the {@code convert} bi-function + * @param instance the second argument for the bi-function * @param convert the function consuming the closeable and supplying the result * * @param the auto-closeable type, will be applied and closed diff --git a/src/main/java/io/earcam/unexceptional/Exceptional.java b/src/main/java/io/earcam/unexceptional/Exceptional.java index 07e367a..03be924 100644 --- a/src/main/java/io/earcam/unexceptional/Exceptional.java +++ b/src/main/java/io/earcam/unexceptional/Exceptional.java @@ -331,8 +331,6 @@ public static T call(Callable callable) *

* The interrupt flag will be reset IFF {@code caught instanceof InterruptedException} *

- *

- *

* * @param caught any {@link Throwable} * @return a {@link RuntimeException}, typically a subclass of {@link UncheckedException} or an @@ -1003,6 +1001,8 @@ public static void closeAfterAccepting(C closeable, Ch /** * Invokes the {@link Iterable#forEach(Consumer)} method having unchecked the consumer * + * @param the consumed {@link Iterable}'s element type + * * @param iterable the Iterable to consume each element of * @param consumer the checked consumer of the Iterable's elements * @@ -1017,7 +1017,10 @@ public static void forEach(Iterable iterable, CheckedConsumer consumer /** - * Invokes the {@link Map#forEach(Consumer)} method having unchecked the bi-consumer + * Invokes the {@link Map#forEach(BiConsumer)} method having unchecked the bi-consumer + * + * @param the consumed {@link Map}'s key type + * @param the consumed {@link Map}'s value type * * @param map the entries to consume * @param consumer the consumer of the map's key value pairs