Javadoc updates (#16)

Fixes #14

Author: mchmielarz

pom.xml

@@ -11,6 +11,7 @@
     <name>AssertJ fluent assertions for Vavr</name>
     <description>Rich and fluent assertions for testing Vavr tools</description>
     <inceptionYear>2017</inceptionYear>
+
     <scm>
         <developerConnection>scm:git:[email protected]:assertj/assertj-vavr.git</developerConnection>
         <connection>scm:git:[email protected]:assertj/assertj-vavr.git</connection>
@@ -40,6 +41,7 @@
             <version>4.12</version>
         </dependency>
     </dependencies>
+
     <build>
         <plugins>
             <plugin>
@@ -51,6 +53,20 @@
                     <target>1.8</target>
                 </configuration>
             </plugin>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>2.10.3</version>
+                <executions>
+                    <execution>
+                        <id>attach-javadocs</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
             <!-- generate jacoco report -->
         </plugins>
     </build>

src/main/java/org/assertj/vavr/api/AbstractOptionAssert.java

@@ -76,7 +76,7 @@ public SELF isEmpty() {
     }
 
     /**
-     * Verifies that the actual {@link io.vavr.control.Option} contains the given value (alias of {@link #hasValue(Object)}).
+     * Verifies that the actual {@link io.vavr.control.Option} contains the given value.
      *
      * @param expectedValue the expected value inside the {@link io.vavr.control.Option}.
      * @return this assertion object.
@@ -190,6 +190,7 @@ public SELF containsSame(VALUE expectedValue) {
     /**
      * Call {@link Option#flatMap(Function) flatMap} on the {@code Option} under test, assertions chained afterwards are performed on the {@code Option} resulting from the flatMap call.
      *
+     * @param <U> the type of a value contained in {@link Option}.
      * @param mapper the {@link Function} to use in the {@link Option#flatMap(Function) flatMap} operation.
      * @return a new {@link org.assertj.vavr.api.AbstractOptionAssert} for assertions chaining on the flatMap of the Option.
      * @throws AssertionError if the actual {@link Option} is null.
@@ -203,6 +204,7 @@ public <U> AbstractOptionAssert<?, U> flatMap(Function<? super VALUE, Option<U>>
     /**
      * Call {@link Option#map(Function) map} on the {@code Option} under test, assertions chained afterwards are performed on the {@code Option} resulting from the map call.
      *
+     * @param <U> the type of a value contained in {@link Option}.
      * @param mapper the {@link Function} to use in the {@link Option#map(Function) map} operation.
      * @return a new {@link org.assertj.vavr.api.AbstractOptionAssert} for assertions chaining on the map of the Option.
      * @throws AssertionError if the actual {@link Option} is null.

src/main/java/org/assertj/vavr/api/AbstractTryAssert.java

@@ -170,7 +170,9 @@ public SELF containsSame(VALUE expectedValue) {
     /**
      * Call {@link Try#flatMap(Function) flatMap} on the {@code Try} under test, assertions chained afterwards are performed on the {@code Try} resulting from the flatMap call.
      *
+     * @param <U> type of a value contained by successful {@link Try} created by {@code mapper} function
      * @param mapper the {@link Function} to use in the {@link Try#flatMap(Function) flatMap} operation.
+     *
      * @return a new {@link org.assertj.vavr.api.AbstractTryAssert} for assertions chaining on the flatMap of the Try.
      * @throws AssertionError if the actual {@link Try} is null.
      */
@@ -183,7 +185,9 @@ public <U> AbstractTryAssert<?, U> flatMap(Function<? super VALUE, Try<U>> mappe
     /**
      * Call {@link Try#map(Function) map} on the {@code Try} under test, assertions chained afterwards are performed on the {@code Try} resulting from the map call.
      *
+     * @param <U> type of a value created by {@code mapper} function
      * @param mapper the {@link Function} to use in the {@link Try#map(Function) map} operation.
+     *
      * @return a new {@link org.assertj.vavr.api.AbstractTryAssert} for assertions chaining on the map of the Try.
      * @throws AssertionError if the actual {@link Try} is null.
      */
@@ -194,9 +198,11 @@ public <U> AbstractTryAssert<?, U> map(Function<? super VALUE, ? extends U> mapp
     }
 
     /**
-     * Verifies that the actual @{@link io.vavr.control.Try} fails because of specific {@link Throwable}.
+     * Verifies that the actual {@link Try} fails because of specific {@link Throwable}.
      *
+     * @param <U> specific type of {@link Throwable}
      * @param reason the expected exception class.
+     *
      * @return this assertion object.
      */
     public <U extends Throwable> SELF failBecauseOf(Class<U> reason) {

src/main/java/org/assertj/vavr/api/VavrAssertions.java

@@ -32,6 +32,10 @@ private VavrAssertions() {
     /**
      * Create assertion for {@link io.vavr.control.Either}.
      *
+     * @param <LEFT> the type of a value contained on left by <code>actual {@link Either}</code>.
+     * @param <RIGHT> the type of a value contained on right by <code>actual {@link Either}</code>.
+     * @param actual the actual value.
+     *
      * @return the created assertion object.
      */
     @CheckReturnValue
@@ -42,6 +46,9 @@ public static <LEFT, RIGHT> EitherAssert<LEFT, RIGHT> assertThat(Either<LEFT, RI
     /**
      * Create assertion for {@link io.vavr.control.Option}.
      *
+     * @param <VALUE> the type of a value contained by <code>actual {@link Option}</code>.
+     * @param actual the actual value.
+     *
      * @return the created assertion object.
      */
     @CheckReturnValue
@@ -52,6 +59,9 @@ public static <VALUE> OptionAssert<VALUE> assertThat(Option<VALUE> actual) {
     /**
      * Create assertion for {@link io.vavr.control.Try}.
      *
+     * @param <VALUE> the type of a value contained by <code>actual {@link Try}</code>.
+     * @param actual the actual value.
+     *
      * @return the created assertion object.
      */
     @CheckReturnValue