Add missing Javadoc that the build reported

sky-uk · Nov 3, 2016 · 8395709 · 8395709
1 parent da1d97d
commit 8395709
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/build.gradle b/build.gradle
@@ -135,4 +135,4 @@ task functional (dependsOn: ['testJar']) << {
     }
 }
 
-check.dependsOn(functional)
+check.dependsOn(functional, javadoc)
diff --git a/src/main/java/uk/sky/cqlmigrate/CassandraClusterFactory.java b/src/main/java/uk/sky/cqlmigrate/CassandraClusterFactory.java
@@ -7,6 +7,12 @@ public class CassandraClusterFactory {
     /**
      * Creates an instance of cassandra {@link Cluster} based on the provided configuration
      *
+     * @param hosts Addresses of the nodes to add as contact points (as described in
+     *              {@link Cluster.Builder#addContactPoint}).
+     * @param port The port to use to connect to the Cassandra hosts.
+     * @param username the username to use to login to Cassandra hosts.
+     * @param password the password corresponding to {@code username}.
+     *
      * @return a configured Cluster
      */
     public static Cluster createCluster(String[] hosts, int port, String username, String password) {