fix javadoc errors

quicktheories · Feb 2, 2018 · 32ebcf7 · 32ebcf7
1 parent 064d55a
commit 32ebcf7
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 7 deletions.
diff --git a/core/src/main/java/org/quicktheories/core/Gen.java b/core/src/main/java/org/quicktheories/core/Gen.java
@@ -118,7 +118,7 @@ default <B,C> Gen<C> zip(Gen<B> b, BiFunction<T,B,C> mapping) {
    * Combines output of this Gen with two others using mapping
    * @param <B> Type to combine with
    * @param <C> Type to combine with
-   * @param <D> Type to generate
+   * @param <R> Type to generate
    * @param b A Gen of B
    * @param c A Gen of C
    * @param mapping function to use to combine values
@@ -132,7 +132,7 @@ default <B,C, R> Gen<R> zip(Gen<B> b, Gen<C> c, Function3<T,B,C,R> mapping) {
    * Combines output of this Gen with others using mapping
    * @param <B> Type to combine with
    * @param <C> Type to combine with
-   * @param <D> Type to generate
+   * @param <R> Type to generate
    * @param b A Gen of B
    * @param c A Gen of C
    * @param d A Gen of D
@@ -147,7 +147,7 @@ default <B,C,D,R> Gen<R> zip(Gen<B> b, Gen<C> c, Gen<D> d, Function4<T,B,C,D,R>
    * Combines output of this Gen with others using mapping
    * @param <B> Type to combine with
    * @param <C> Type to combine with
-   * @param <D> Type to generate
+   * @param <R> Type to generate
    * @param b A Gen of B
    * @param c A Gen of C
    * @param d A Gen of D

diff --git a/core/src/main/java/org/quicktheories/core/Strategy.java b/core/src/main/java/org/quicktheories/core/Strategy.java
@@ -149,8 +149,8 @@ public Strategy withShrinkCycles(int shrinks) {
 
   /**
    * Creates a strategy using the supplied reporter
-   * @param reporter
-   * @return
+   * @param reporter Reporter to use
+   * @return a strategy with suppled reporter
    */
   public Strategy withReporter(Reporter reporter) {
     return new Strategy(prng, examples, shrinkCycles, generateAttempts, reporter, guidance);

diff --git a/core/src/main/java/org/quicktheories/generators/MapsDSL.java b/core/src/main/java/org/quicktheories/generators/MapsDSL.java
@@ -13,14 +13,17 @@ public class MapsDSL {
   /**
    * Creates a ListGeneratorBuilder.
    *
+   * @param keys Gen of keys
+   * @param values Gen of values
+   *
    * @param <K>
    *          key type to generate
    * @param <V>
    *          value type to generate
    * @return a MapGeneratorBuilder of type K,V
    */
-  public <K, V> MapGeneratorBuilder<K, V> of(Gen<K> kg, Gen<V> vg) {
-    return new MapGeneratorBuilder<>(kg, vg);
+  public <K, V> MapGeneratorBuilder<K, V> of(Gen<K> keys, Gen<V> values) {
+    return new MapGeneratorBuilder<>(keys, values);
   }
 
   /**