Fixed invalid javadoc (#2357)

vavr-io · Jan 20, 2019 · 99e52c6 · 99e52c6
1 parent dab7cc4
commit 99e52c6
Show file tree

Hide file tree

Showing 22 changed files with 24 additions and 27 deletions.
diff --git a/vavr/generator/Generator.scala b/vavr/generator/Generator.scala
@@ -1670,7 +1670,7 @@ def generateMainClasses(): Unit = {
 
               /**
                * Returns the number of function arguments.
-               * @return an int value >= 0
+               * @return an int value &gt;= 0
                * @see <a href="http://en.wikipedia.org/wiki/Arity">Arity</a>
                */
               default int arity() {

diff --git a/vavr/src-gen/main/java/io/vavr/CheckedFunction0.java b/vavr/src-gen/main/java/io/vavr/CheckedFunction0.java
@@ -143,7 +143,7 @@ static <R> CheckedFunction0<R> narrow(CheckedFunction0<? extends R> f) {
 
     /**
      * Returns the number of function arguments.
-     * @return an int value >= 0
+     * @return an int value &gt;= 0
      * @see <a href="http://en.wikipedia.org/wiki/Arity">Arity</a>
      */
     default int arity() {

diff --git a/vavr/src-gen/main/java/io/vavr/CheckedFunction1.java b/vavr/src-gen/main/java/io/vavr/CheckedFunction1.java
@@ -160,7 +160,7 @@ static <T> CheckedFunction1<T, T> identity() {
 
     /**
      * Returns the number of function arguments.
-     * @return an int value >= 0
+     * @return an int value &gt;= 0
      * @see <a href="http://en.wikipedia.org/wiki/Arity">Arity</a>
      */
     default int arity() {

diff --git a/vavr/src-gen/main/java/io/vavr/CheckedFunction2.java b/vavr/src-gen/main/java/io/vavr/CheckedFunction2.java
@@ -168,7 +168,7 @@ default CheckedFunction1<T2, R> apply(T1 t1) {
 
     /**
      * Returns the number of function arguments.
-     * @return an int value >= 0
+     * @return an int value &gt;= 0
      * @see <a href="http://en.wikipedia.org/wiki/Arity">Arity</a>
      */
     default int arity() {

diff --git a/vavr/src-gen/main/java/io/vavr/CheckedFunction3.java b/vavr/src-gen/main/java/io/vavr/CheckedFunction3.java
@@ -185,7 +185,7 @@ default CheckedFunction1<T3, R> apply(T1 t1, T2 t2) {
 
     /**
      * Returns the number of function arguments.
-     * @return an int value >= 0
+     * @return an int value &gt;= 0
      * @see <a href="http://en.wikipedia.org/wiki/Arity">Arity</a>
      */
     default int arity() {

diff --git a/vavr/src-gen/main/java/io/vavr/CheckedFunction4.java b/vavr/src-gen/main/java/io/vavr/CheckedFunction4.java
@@ -204,7 +204,7 @@ default CheckedFunction1<T4, R> apply(T1 t1, T2 t2, T3 t3) {
 
     /**
      * Returns the number of function arguments.
-     * @return an int value >= 0
+     * @return an int value &gt;= 0
      * @see <a href="http://en.wikipedia.org/wiki/Arity">Arity</a>
      */
     default int arity() {

diff --git a/vavr/src-gen/main/java/io/vavr/CheckedFunction5.java b/vavr/src-gen/main/java/io/vavr/CheckedFunction5.java
@@ -224,7 +224,7 @@ default CheckedFunction1<T5, R> apply(T1 t1, T2 t2, T3 t3, T4 t4) {
 
     /**
      * Returns the number of function arguments.
-     * @return an int value >= 0
+     * @return an int value &gt;= 0
      * @see <a href="http://en.wikipedia.org/wiki/Arity">Arity</a>
      */
     default int arity() {

diff --git a/vavr/src-gen/main/java/io/vavr/CheckedFunction6.java b/vavr/src-gen/main/java/io/vavr/CheckedFunction6.java
@@ -245,7 +245,7 @@ default CheckedFunction1<T6, R> apply(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5) {
 
     /**
      * Returns the number of function arguments.
-     * @return an int value >= 0
+     * @return an int value &gt;= 0
      * @see <a href="http://en.wikipedia.org/wiki/Arity">Arity</a>
      */
     default int arity() {

diff --git a/vavr/src-gen/main/java/io/vavr/CheckedFunction7.java b/vavr/src-gen/main/java/io/vavr/CheckedFunction7.java
@@ -267,7 +267,7 @@ default CheckedFunction1<T7, R> apply(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6)
 
     /**
      * Returns the number of function arguments.
-     * @return an int value >= 0
+     * @return an int value &gt;= 0
      * @see <a href="http://en.wikipedia.org/wiki/Arity">Arity</a>
      */
     default int arity() {

diff --git a/vavr/src-gen/main/java/io/vavr/CheckedFunction8.java b/vavr/src-gen/main/java/io/vavr/CheckedFunction8.java
@@ -290,7 +290,7 @@ default CheckedFunction1<T8, R> apply(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6,
 
     /**
      * Returns the number of function arguments.
-     * @return an int value >= 0
+     * @return an int value &gt;= 0
      * @see <a href="http://en.wikipedia.org/wiki/Arity">Arity</a>
      */
     default int arity() {

diff --git a/vavr/src-gen/main/java/io/vavr/Function0.java b/vavr/src-gen/main/java/io/vavr/Function0.java
@@ -151,7 +151,7 @@ default R get() {
 
     /**
      * Returns the number of function arguments.
-     * @return an int value >= 0
+     * @return an int value &gt;= 0
      * @see <a href="http://en.wikipedia.org/wiki/Arity">Arity</a>
      */
     default int arity() {

diff --git a/vavr/src-gen/main/java/io/vavr/Function1.java b/vavr/src-gen/main/java/io/vavr/Function1.java
@@ -159,7 +159,7 @@ static <T> Function1<T, T> identity() {
 
     /**
      * Returns the number of function arguments.
-     * @return an int value >= 0
+     * @return an int value &gt;= 0
      * @see <a href="http://en.wikipedia.org/wiki/Arity">Arity</a>
      */
     default int arity() {

diff --git a/vavr/src-gen/main/java/io/vavr/Function2.java b/vavr/src-gen/main/java/io/vavr/Function2.java
@@ -166,7 +166,7 @@ default Function1<T2, R> apply(T1 t1) {
 
     /**
      * Returns the number of function arguments.
-     * @return an int value >= 0
+     * @return an int value &gt;= 0
      * @see <a href="http://en.wikipedia.org/wiki/Arity">Arity</a>
      */
     default int arity() {

diff --git a/vavr/src-gen/main/java/io/vavr/Function3.java b/vavr/src-gen/main/java/io/vavr/Function3.java
@@ -183,7 +183,7 @@ default Function1<T3, R> apply(T1 t1, T2 t2) {
 
     /**
      * Returns the number of function arguments.
-     * @return an int value >= 0
+     * @return an int value &gt;= 0
      * @see <a href="http://en.wikipedia.org/wiki/Arity">Arity</a>
      */
     default int arity() {

diff --git a/vavr/src-gen/main/java/io/vavr/Function4.java b/vavr/src-gen/main/java/io/vavr/Function4.java
@@ -202,7 +202,7 @@ default Function1<T4, R> apply(T1 t1, T2 t2, T3 t3) {
 
     /**
      * Returns the number of function arguments.
-     * @return an int value >= 0
+     * @return an int value &gt;= 0
      * @see <a href="http://en.wikipedia.org/wiki/Arity">Arity</a>
      */
     default int arity() {

diff --git a/vavr/src-gen/main/java/io/vavr/Function5.java b/vavr/src-gen/main/java/io/vavr/Function5.java
@@ -222,7 +222,7 @@ default Function1<T5, R> apply(T1 t1, T2 t2, T3 t3, T4 t4) {
 
     /**
      * Returns the number of function arguments.
-     * @return an int value >= 0
+     * @return an int value &gt;= 0
      * @see <a href="http://en.wikipedia.org/wiki/Arity">Arity</a>
      */
     default int arity() {

diff --git a/vavr/src-gen/main/java/io/vavr/Function6.java b/vavr/src-gen/main/java/io/vavr/Function6.java
@@ -243,7 +243,7 @@ default Function1<T6, R> apply(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5) {
 
     /**
      * Returns the number of function arguments.
-     * @return an int value >= 0
+     * @return an int value &gt;= 0
      * @see <a href="http://en.wikipedia.org/wiki/Arity">Arity</a>
      */
     default int arity() {

diff --git a/vavr/src-gen/main/java/io/vavr/Function7.java b/vavr/src-gen/main/java/io/vavr/Function7.java
@@ -265,7 +265,7 @@ default Function1<T7, R> apply(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6) {
 
     /**
      * Returns the number of function arguments.
-     * @return an int value >= 0
+     * @return an int value &gt;= 0
      * @see <a href="http://en.wikipedia.org/wiki/Arity">Arity</a>
      */
     default int arity() {

diff --git a/vavr/src-gen/main/java/io/vavr/Function8.java b/vavr/src-gen/main/java/io/vavr/Function8.java
@@ -288,7 +288,7 @@ default Function1<T8, R> apply(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6, T7 t7)
 
     /**
      * Returns the number of function arguments.
-     * @return an int value >= 0
+     * @return an int value &gt;= 0
      * @see <a href="http://en.wikipedia.org/wiki/Arity">Arity</a>
      */
     default int arity() {

diff --git a/vavr/src/main/java/io/vavr/control/Either.java b/vavr/src/main/java/io/vavr/control/Either.java
@@ -453,7 +453,6 @@ default Option<Either<L, R>> filter(Predicate<? super R> predicate) {
      * If the {@code Either} is a {@code Right} and the predicate doesn't match, the
      * {@code Either} will be turned into a {@code Left} with contents computed by applying
      * the filterVal function to the {@code Either} value.
-     * <p>
      *
      * <pre>{@code
      * import static io.vavr.API.*;
@@ -466,11 +465,11 @@ default Option<Either<L, R>> filter(Predicate<? super R> predicate) {
      * }</pre>
      *
      * @param predicate A predicate
+     * @param zero      A function that turns a right value into a left value if the right value does not make it through the filter.
      * @return an {@code Either} instance
      * @throws NullPointerException if {@code predicate} is null
      */
-    default Either<L,R> filterOrElse(Predicate<? super R> predicate,
-                                     Function<? super R, ? extends L> zero) {
+    default Either<L,R> filterOrElse(Predicate<? super R> predicate, Function<? super R, ? extends L> zero) {
         Objects.requireNonNull(predicate, "predicate is null");
         Objects.requireNonNull(zero, "zero is null");
         if (isLeft() || predicate.test(get())) {

diff --git a/vavr/src/main/java/io/vavr/control/Try.java b/vavr/src/main/java/io/vavr/control/Try.java
@@ -1009,11 +1009,9 @@ default Validation<Throwable, T> toValidation() {
      * Converts this {@code Try} to a {@link Validation}, converting the Throwable (if present)
      * to another object using passed {@link Function}.
      *
-     * <pre>
-     * <code>
+     * <pre>{@code
      * Validation<String, Integer> = Try.of(() -> 1/0).toValidation(Throwable::getMessage));
-     * </code>
-     * </pre>
+     * }</pre>
      *
      * @param <U> result type of the throwable mapper
      * @param throwableMapper  A transformation from throwable to desired invalid type of new {@code Validation}

diff --git a/vavr/src/main/java/io/vavr/package-info.java b/vavr/src/main/java/io/vavr/package-info.java
@@ -1,4 +1,4 @@
 /**
- * The io.vavr package contains core types like {@linkplain io.vavr.Lambda}, {@linkplain io.vavr.Lazy} and {@linkplain io.vavr.Tuple}.
+ * Beside {@link io.vavr.API} the io.vavr package contains core types like (Checked)Functions and Tuples.
  */
 package io.vavr;