Fix: Missing javadocs for pattern matching and other components (#3095)

Author: adamkopec

vavr/generator/Generator.scala

@@ -235,7 +235,7 @@ default boolean isMemoized() {
 
     /**
      * Converts this {@code Function1} to a {@link PartialFunction} by adding an {@code isDefinedAt} condition.
-     * <p>
+     *
      * @param isDefinedAt a predicate that states if an element is in the domain of the returned {@code PartialFunction}.
      * @return a new {@code PartialFunction} that has the same behavior like this function but is defined only for those elements that make it through the given {@code Predicate}
      * @throws NullPointerException if {@code isDefinedAt} is null

vavr/src-gen/main/java/io/vavr/API.java

@@ -51,7 +51,8 @@
  * Example of creating a <em>real</em> lazy value (works only with interfaces):
  *
  * <pre><code>final CharSequence chars = Lazy.val(() -&gt; "Yay!", CharSequence.class);</code></pre>
- *
+ * 
+ * @param <T> The type of the lazy evaluated value 
  * @author Daniel Dietrich
  */
 // DEV-NOTE: No flatMap and orElse because this more like a Functor than a Monad.

vavr/src-gen/main/java/io/vavr/Function1.java

@@ -34,12 +34,21 @@
 /**
  * An immutable {@code BitSet} implementation.
  *
+ * @param <T> Component type
  * @author Ruslan Sennov
  */
 public interface BitSet<T> extends SortedSet<T> {
 
+    /**
+     * The <a href="https://docs.oracle.com/javase/8/docs/api/index.html">serial version uid</a>.
+     */
     long serialVersionUID = 1L;
 
+    /**
+     * Builder of the BitSet. Encapsulates the conversion functions for T.
+     *
+     * @param <T> Component type
+     */
     class Builder<T> {
 
         final static Builder<Integer> DEFAULT = new Builder<>(i -> i, i -> i);
@@ -52,6 +61,12 @@ class Builder<T> {
             this.toInt = toInt;
         }
 
+        /**
+         * Returns a {@link java.util.stream.Collector} which may be used in conjunction with
+         * {@link java.util.stream.Stream#collect(java.util.stream.Collector)} to obtain an {@link ArrayList}.
+         *
+         * @return A {@link ArrayList} Collector.
+         */
         public Collector<T, ArrayList<T>, BitSet<T>> collector() {
             final BinaryOperator<ArrayList<T>> combiner = (left, right) -> {
                 left.addAll(right);
@@ -60,10 +75,21 @@ public Collector<T, ArrayList<T>, BitSet<T>> collector() {
             return Collector.of(ArrayList::new, ArrayList::add, combiner, this::ofAll);
         }
 
+        /**
+         * Returns a new empty BitSet
+         *
+         * @return new empty BitSet
+         */
         public BitSet<T> empty() {
             return new BitSetModule.BitSet1<>(fromInt, toInt, 0L);
         }
 
+        /**
+         * Builds a new BitSet from a specific value t
+         *
+         * @param t value to build the BitSet from
+         * @return new BitSet
+         */
         public BitSet<T> of(T t) {
             final int value = toInt.apply(t);
             if (value < BitSetModule.BITS_PER_WORD) {
@@ -75,27 +101,59 @@ public BitSet<T> of(T t) {
             }
         }
 
+        /**
+         * Builds a new BitSet from a list of values
+         *
+         * @param values values to build the BitSet from
+         * @return new BitSet
+         */
         @SuppressWarnings("varargs")
         @SafeVarargs
         public final BitSet<T> of(T... values) {
             return empty().addAll(Array.wrap(values));
         }
 
+        /**
+         * Builds a new BitSet from an {@link Iterable}
+         *
+         * @param values iterable to build the BitSet from
+         * @return new BitSet
+         */
         public BitSet<T> ofAll(Iterable<? extends T> values) {
             Objects.requireNonNull(values, "values is null");
             return empty().addAll(values);
         }
 
+        /**
+         * Builds a new BitSet from a {@link java.util.stream.Stream} of values
+         *
+         * @param javaStream stream of values to build the BitSet from
+         * @return new BitSet
+         */
         public BitSet<T> ofAll(java.util.stream.Stream<? extends T> javaStream) {
             Objects.requireNonNull(javaStream, "javaStream is null");
             return empty().addAll(Iterator.ofAll(javaStream.iterator()));
         }
 
+        /**
+         * Builds a new BitSet tabulating a value n times
+         *
+         * @param n number of times to tabulate
+         * @param f function to tabulate
+         * @return new BitSet
+         */
         public BitSet<T> tabulate(int n, Function<? super Integer, ? extends T> f) {
             Objects.requireNonNull(f, "f is null");
             return empty().addAll(Collections.tabulate(n, f));
         }
 
+        /**
+         * Builds a new BitSet containing n copies of the same value
+         *
+         * @param n number of times to copy the value
+         * @param s value supplier
+         * @return new BitSet
+         */
         public BitSet<T> fill(int n, Supplier<? extends T> s) {
             Objects.requireNonNull(s, "s is null");
             return empty().addAll(Collections.fill(n, s));
@@ -115,14 +173,29 @@ static Builder<Character> withCharacters() {
         return new Builder<>(i -> (char) i.intValue(), c -> (int) c);
     }
 
+    /**
+     * Returns new {@link BitSet} Builder for type {@link Byte}
+     *
+     * @return new Builder
+     */
     static Builder<Byte> withBytes() {
         return new Builder<>(Integer::byteValue, Byte::intValue);
     }
 
+    /**
+     * Returns new {@link BitSet} Builder for type {@link Long}
+     *
+     * @return new Builder
+     */
     static Builder<Long> withLongs() {
         return new Builder<>(Integer::longValue, Long::intValue);
     }
 
+    /**
+     * Returns new {@link BitSet} Builder for type {@link Short}
+     *
+     * @return new Builder
+     */
     static Builder<Short> withShorts() {
         return new Builder<>(Integer::shortValue, Short::intValue);
     }

vavr/src/main/java/io/vavr/Lazy.java

@@ -2541,7 +2541,6 @@ public CharSeq toLowerCase(Locale locale) {
      * LATIN SMALL LETTER DOTLESS I character.
      * To obtain correct results for locale insensitive strings, use
      * {@code toLowerCase(Locale.ROOT)}.
-     * <p>
      *
      * @return the {@code CharSeq}, converted to lowercase.
      * @see String#toLowerCase(Locale)
@@ -2618,7 +2617,6 @@ public CharSeq toUpperCase(Locale locale) {
      * LATIN CAPITAL LETTER I WITH DOT ABOVE character.
      * To obtain correct results for locale insensitive strings, use
      * {@code toUpperCase(Locale.ROOT)}.
-     * <p>
      *
      * @return the {@code CharSeq}, converted to uppercase.
      * @see String#toUpperCase(Locale)
@@ -2697,7 +2695,6 @@ public CharSeq capitalize(Locale locale) {
      * LATIN CAPITAL LETTER I WITH DOT ABOVE character.
      * To obtain correct results for locale insensitive strings, use
      * {@code toUpperCase(Locale.ROOT)}.
-     * <p>
      *
      * @return the {@code CharSeq}, capitalized.
      */

vavr/src/main/java/io/vavr/collection/BitSet.java

@@ -33,6 +33,8 @@
  * An immutable {@code HashMap} implementation based on a
  * <a href="https://en.wikipedia.org/wiki/Hash_array_mapped_trie">Hash array mapped trie (HAMT)</a>.
  *
+ * @param <K> Key type
+ * @param <V> Value type
  * @author Ruslan Sennov, Patryk Najda, Daniel Dietrich
  */
 public final class HashMap<K, V> implements Map<K, V>, Serializable {

vavr/src/main/java/io/vavr/collection/CharSeq.java

@@ -31,6 +31,8 @@
 /**
  * An immutable {@code LinkedHashMap} implementation that has predictable (insertion-order) iteration.
  *
+ * @param <K> Key type
+ * @param <V> Value type
  * @author Ruslan Sennov
  */
 public final class LinkedHashMap<K, V> implements Map<K, V>, Serializable {

vavr/src/main/java/io/vavr/collection/HashMap.java

@@ -30,6 +30,7 @@
 /**
  * A PriorityQueue.
  *
+ * @param <T> Component type
  * @author Pap Lőrinc
  */
 public final class PriorityQueue<T> extends io.vavr.collection.AbstractQueue<T, PriorityQueue<T>> implements Serializable, Ordered<T> {

vavr/src/main/java/io/vavr/collection/LinkedHashMap.java

@@ -31,7 +31,7 @@ public interface Task<T> {
 
     /**
      * Completes a task.
-     * <p>
+     *
      * @param <T> result type
      */
     @FunctionalInterface