Fixing javadoc

jnape · jnape · commit 9e2fb4892352 · 2019-01-27T19:55:04.000-06:00
diff --git a/src/main/java/com/jnape/palatable/lambda/functions/IO.java b/src/main/java/com/jnape/palatable/lambda/functions/IO.java
@@ -46,6 +46,7 @@ default CompletableFuture<A> unsafePerformAsyncIO() {
      * constructions may allow this method to delegate to externally-managed {@link CompletableFuture} instead of
      * synthesizing their own.
      *
+     * @param executor the {@link Executor} to run the {@link CompletableFuture} from
      * @return the {@link CompletableFuture} representing this {@link IO}'s eventual result
      * @see IO#unsafePerformAsyncIO()
      */
diff --git a/src/main/java/com/jnape/palatable/lambda/lens/lenses/MapLens.java b/src/main/java/com/jnape/palatable/lambda/lens/lenses/MapLens.java
@@ -3,8 +3,8 @@
 import com.jnape.palatable.lambda.adt.Maybe;
 import com.jnape.palatable.lambda.adt.hlist.Tuple2;
 import com.jnape.palatable.lambda.functions.Fn1;
-import com.jnape.palatable.lambda.functions.builtin.fn2.Filter;
 import com.jnape.palatable.lambda.functions.IO;
+import com.jnape.palatable.lambda.functions.builtin.fn2.Filter;
 import com.jnape.palatable.lambda.lens.Iso;
 import com.jnape.palatable.lambda.lens.Lens;
 
@@ -40,9 +40,10 @@ private MapLens() {
      * A lens that focuses on a copy of a {@link Map} as a subtype <code>M</code>. Useful for composition to avoid
      * mutating a map reference.
      *
-     * @param <M> the map subtype
-     * @param <K> the key type
-     * @param <V> the value type
+     * @param <M>    the map subtype
+     * @param <K>    the key type
+     * @param <V>    the value type
+     * @param copyFn the copy function
      * @return a lens that focuses on copies of maps as a specific subtype
      */
     public static <M extends Map<K, V>, K, V> Lens<Map<K, V>, M, M, M> asCopy(
@@ -65,10 +66,11 @@ public static <K, V> Lens.Simple<Map<K, V>, Map<K, V>> asCopy() {
      * A lens that focuses on a value at a key in a map, as a {@link Maybe}, and produces a subtype <code>M</code> on
      * the way back out.
      *
-     * @param <M> the map subtype
-     * @param <K> the key type
-     * @param <V> the value type
-     * @param k   the key to focus on
+     * @param <M>    the map subtype
+     * @param <K>    the key type
+     * @param <V>    the value type
+     * @param k      the key to focus on
+     * @param copyFn the copy function
      * @return a lens that focuses on the value at key, as a {@link Maybe}
      */
     public static <M extends Map<K, V>, K, V> Lens<Map<K, V>, M, Maybe<V>, Maybe<V>> valueAt(
diff --git a/src/main/java/com/jnape/palatable/lambda/monoid/builtin/MergeMaps.java b/src/main/java/com/jnape/palatable/lambda/monoid/builtin/MergeMaps.java
@@ -11,8 +11,8 @@
 import java.util.function.Supplier;
 
 /**
- * A {@link Monoid} instance formed by {@link Map#merge(K, V, BiFunction)} and a semigroup over <code>V</code>.
- * Combines together multiple maps using the provided semigroup for key collisions.
+ * A {@link Monoid} instance formed by {@link java.util.Map#merge(Object, Object, BiFunction)} and a semigroup over
+ * <code>V</code>. Combines together multiple maps using the provided semigroup for key collisions.
  *
  * @param <K> The key parameter type of the Map
  * @param <V> The value parameter type of the Map

Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,7 @@ default CompletableFuture<A> unsafePerformAsyncIO() {`
`46`	`46`	`* constructions may allow this method to delegate to externally-managed {@link CompletableFuture} instead of`
`47`	`47`	`* synthesizing their own.`
`48`	`48`	`*`
	`49`	`+ * @param executor the {@link Executor} to run the {@link CompletableFuture} from`
`49`	`50`	`* @return the {@link CompletableFuture} representing this {@link IO}'s eventual result`
`50`	`51`	`* @see IO#unsafePerformAsyncIO()`
`51`	`52`	`*/`