Fixes #21

Create OptionalX JavaDoc

Author: alexengrig

src/main/java/io/github/alexengrig/lambdax/OptionalX.java

@@ -22,26 +22,56 @@
 import java.util.function.UnaryOperator;
 
 /**
- * This utility class contains useful lambdas for {@link Optional}
+ * This utility class contains useful lambdas for {@link java.util.Optional}.
  *
  * @author Grig Alex
- * @see Optional
- * @see Consumer
- * @see UnaryOperator
+ * @version 0.1.1
+ * @see java.util.Optional
+ * @see java.util.function.Consumer
+ * @see java.util.function.Supplier
+ * @see java.util.function.UnaryOperator
  * @since 0.1.0
  */
 public final class OptionalX {
     private OptionalX() {
     }
 
+    /**
+     * <p>Returns an {@link java.util.Optional} describing the given value
+     * from {@link java.util.function.Supplier}.</p>
+     *
+     * @param generator a {@link java.util.function.Supplier} of value
+     *                  the result of which is passed as the argument to {@link java.util.Optional#ofNullable(Object)}
+     * @param <T>       a type of {@link java.util.Optional} value
+     * @return an {@link java.util.Optional} with the given value from {@link java.util.function.Supplier}
+     * @see java.util.Optional#ofNullable(Object)
+     * @see java.util.Optional
+     * @see java.util.Optional#ofNullable(Object)
+     * @see java.util.Optional
+     * @see java.util.function.Supplier
+     * @since 0.1.0
+     */
     public static <T> Optional<T> of(Supplier<? extends T> generator) {
         return Optional.ofNullable(generator.get());
     }
 
+    /**
+     * <p>Returns an {@link java.util.function.UnaryOperator}
+     * that execute the action ({@link java.util.function.Consumer}) for a value and return it.</p>
+     *
+     * @param action a {@link java.util.function.Consumer} that execute an action on a value
+     * @param <T>    a type of the operand and result of the operator
+     * @return an {@link java.util.function.UnaryOperator}
+     * @see java.util.Optional#map(java.util.function.Function)
+     * @see java.util.function.UnaryOperator
+     * @see java.util.function.Consumer
+     * @see java.util.stream.Stream#peek(Consumer)
+     * @since 0.1.0
+     */
     public static <T> UnaryOperator<T> peek(Consumer<? super T> action) {
         return t -> {
             action.accept(t);
             return t;
         };
     }
-}
+}