some minor improvements in Javadoc

doctore · Mar 17, 2024 · a1addb0 · a1addb0
1 parent a4f670e
commit a1addb0
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 20 deletions.
diff --git a/common/src/main/java/com/spring5microservices/common/interfaces/function/HeptaFunction.java b/common/src/main/java/com/spring5microservices/common/interfaces/function/HeptaFunction.java
@@ -65,8 +65,8 @@ R apply(final T1 t1,
 
     /**
      *    Returns a composed {@link HeptaFunction} that first applies this {@link HeptaFunction} to its input, and then
-     * applies the after {@link Function} to the result. If evaluation of either function throws an exception, it is relayed
-     * to the caller of the composed {@link HeptaFunction}.
+     * applies the {@code after} {@link Function} to the result. If evaluation of either function throws an exception,
+     * it is relayed to the caller of the composed {@link HeptaFunction}.
      *
      * @param after
      *    The {@link Function} to apply after this {@link HeptaFunction}

diff --git a/common/src/main/java/com/spring5microservices/common/interfaces/function/HexaFunction.java b/common/src/main/java/com/spring5microservices/common/interfaces/function/HexaFunction.java
@@ -60,8 +60,8 @@ R apply(final T1 t1,
 
     /**
      *    Returns a composed {@link HexaFunction} that first applies this {@link HexaFunction} to its input, and then
-     * applies the after {@link Function} to the result. If evaluation of either function throws an exception, it is relayed
-     * to the caller of the composed {@link HexaFunction}.
+     * applies the {@code after} {@link Function} to the result. If evaluation of either function throws an exception,
+     * it is relayed to the caller of the composed {@link HexaFunction}.
      *
      * @param after
      *    The {@link Function} to apply after this {@link HexaFunction}

diff --git a/...on/src/main/java/com/spring5microservices/common/interfaces/function/PartialFunction.java b/...on/src/main/java/com/spring5microservices/common/interfaces/function/PartialFunction.java
@@ -259,9 +259,9 @@ public boolean isDefinedAt(final Map.Entry<K1, V1> entry) {
 
 
     /**
-     *    Returns a composed {@link PartialFunction} that first applies this {@link PartialFunction} to its input, and then
-     * applies the after {@link Function} to the result. If evaluation of either {@link Function} throws an {@link Exception},
-     * it is relayed to the caller of the composed {@link PartialFunction}.
+     *    Returns a composed {@link PartialFunction} that first applies this {@link PartialFunction} to its input, and
+     * then applies the {@code after} {@link Function} to the result. If evaluation of either {@link Function} throws
+     * an {@link Exception}, it is relayed to the caller of the composed {@link PartialFunction}.
      *
      * @param after
      *    The {@link Function} to apply after this {@link PartialFunction} is applied
@@ -298,9 +298,9 @@ public boolean isDefinedAt(final T t) {
 
 
     /**
-     *    Returns a composed {@link PartialFunction} that first applies this {@link PartialFunction} to its input, and then
-     * applies the after {@link PartialFunction} to the result. If evaluation of either {@link Function} throws an {@link Exception},
-     * it is relayed to the caller of the composed {@link PartialFunction}.
+     *    Returns a composed {@link PartialFunction} that first applies this {@link PartialFunction} to its input, and
+     * then applies the {@code after} {@link PartialFunction} to the result. If evaluation of either {@link Function}
+     * throws an {@link Exception}, it is relayed to the caller of the composed {@link PartialFunction}.
      *
      * @param after
      *    The {@link PartialFunction} to apply after this {@link PartialFunction} is applied
@@ -361,8 +361,8 @@ default R applyOrElse(final T t,
 
     /**
      *    Returns a composed {@link PartialFunction} that first applies {@code before} {@link Function} to its input, and
-     * then applies this {@link PartialFunction} to the result. If evaluation of either {@link Function} throws an {@link Exception},
-     * it is relayed to the caller of the composed {@link PartialFunction}.
+     * then applies this {@link PartialFunction} to the result. If evaluation of either {@link Function} throws an
+     * {@link Exception}, it is relayed to the caller of the composed {@link PartialFunction}.
      *
      * @param before
      *    The {@link Function} to apply before this {@link PartialFunction} is applied
@@ -440,8 +440,9 @@ public boolean isDefinedAt(final V v) {
     /**
      * Turns this {@link PartialFunction} into a {@link Function} returning an {@link Optional} result.
      *
-     * @return {@link Function} that takes an argument {@code x} to {@link Optional} of {@link PartialFunction#apply(Object)} if {@code x}
-     *         belongs to the {@link PartialFunction}'s domain, {@link Optional#empty()} otherwise.
+     * @return {@link Function} that takes an argument {@code x} to {@link Optional} of {@link PartialFunction#apply(Object)}
+     *         if {@code x} belongs to the {@link PartialFunction}'s domain,
+     *         {@link Optional#empty()} otherwise.
      */
     default Function<T, Optional<R>> lift() {
         return t ->

diff --git a/common/src/main/java/com/spring5microservices/common/interfaces/function/PentaFunction.java b/common/src/main/java/com/spring5microservices/common/interfaces/function/PentaFunction.java
@@ -55,8 +55,8 @@ R apply(final T1 t1,
 
     /**
      *    Returns a composed {@link PentaFunction} that first applies this {@link PentaFunction} to its input, and then
-     * applies the after {@link Function} to the result. If evaluation of either function throws an exception, it is relayed
-     * to the caller of the composed {@link PentaFunction}.
+     * applies the {@code after} {@link Function} to the result. If evaluation of either function throws an exception,
+     * it is relayed to the caller of the composed {@link PentaFunction}.
      *
      * @param after
      *    The {@link Function} to apply after this {@link PentaFunction}

diff --git a/common/src/main/java/com/spring5microservices/common/interfaces/function/QuadFunction.java b/common/src/main/java/com/spring5microservices/common/interfaces/function/QuadFunction.java
@@ -50,8 +50,8 @@ R apply(final T1 t1,
 
     /**
      *    Returns a composed {@link QuadFunction} that first applies this {@link QuadFunction} to its input, and then
-     * applies the after {@link Function} to the result. If evaluation of either function throws an exception, it is relayed
-     * to the caller of the composed {@link QuadFunction}.
+     * applies the {@code after} {@link Function} to the result. If evaluation of either function throws an exception,
+     * it is relayed to the caller of the composed {@link QuadFunction}.
      *
      * @param after
      *    The {@link Function} to apply after this {@link QuadFunction}

diff --git a/common/src/main/java/com/spring5microservices/common/interfaces/function/TriFunction.java b/common/src/main/java/com/spring5microservices/common/interfaces/function/TriFunction.java
@@ -45,8 +45,8 @@ R apply(final T1 t1,
 
     /**
      *    Returns a composed {@link TriFunction} that first applies this {@link TriFunction} to its input, and then
-     * applies the after {@link Function} to the result. If evaluation of either function throws an exception, it is relayed
-     * to the caller of the composed {@link TriFunction}.
+     * applies the {@code after} {@link Function} to the result. If evaluation of either function throws an exception,
+     * it is relayed to the caller of the composed {@link TriFunction}.
      *
      * @param after
      *    The {@link Function} to apply after this {@link TriFunction}