Merge pull request #305 from eclipse-jnosql/javadoc-improvements

chore: added javadoc improvements

Author: dearrudam

jnosql-arangodb/pom.xml

@@ -21,7 +21,7 @@
     <parent>
         <groupId>org.eclipse.jnosql.databases</groupId>
         <artifactId>jnosql-databases-parent</artifactId>
-        <version>1.1.5--SNAPSHOT</version>
+        <version>1.1.5-SNAPSHOT</version>
     </parent>
 
     <artifactId>jnosql-arangodb</artifactId>

jnosql-arangodb/src/main/java/org/eclipse/jnosql/databases/arangodb/communication/ArangoDBBucketManagerFactory.java

@@ -23,12 +23,15 @@
 import java.util.Set;
 
 /**
- * The ArangoDB implementation to {@link BucketManagerFactory}
- * it does not support:
+ * The ArangoDB implementation to {@link BucketManagerFactory}.
+ * It does not support:
  * <p>{@link BucketManagerFactory#getMap(String, Class, Class)}</p>
  * <p>{@link BucketManagerFactory#getSet(String, Class)}</p>
  * <p>{@link BucketManagerFactory#getQueue(String, Class)}</p>
  * <p>{@link BucketManagerFactory#getList(String, Class)}</p>
+ * <br/>
+ * Closing an ArangoDBBucketManagerFactory has no effect. The ArangoDB driver instance will be closed in
+ * ${@link ArangoDBBucketManager}.close().
  */
 public class ArangoDBBucketManagerFactory implements BucketManagerFactory {
 
@@ -71,10 +74,13 @@ public List getList(String bucketName, Class clazz) throws UnsupportedOperationE
         throw new UnsupportedOperationException("The ArangoDB does not support getList method");
     }
 
+    /**
+     * Closing an {@link ArangoDBBucketManagerFactory} has no effect.
+     * The ArangoDB driver instance will be closed in ${@link ArangoDBBucketManager}.close().
+     */
     @Override
     public void close() {
         // no-op
-        // ArangoDB driver instance will be closed in ArangoDBBucketManager.close()
     }
 
 }

jnosql-cassandra/pom.xml

@@ -21,7 +21,7 @@
     <parent>
         <groupId>org.eclipse.jnosql.databases</groupId>
         <artifactId>jnosql-databases-parent</artifactId>
-        <version>1.1.5--SNAPSHOT</version>
+        <version>1.1.5-SNAPSHOT</version>
     </parent>
 
     <artifactId>jnosql-cassandra</artifactId>

jnosql-cassandra/src/main/java/org/eclipse/jnosql/databases/cassandra/communication/CassandraColumnManagerFactory.java

@@ -24,6 +24,8 @@
 
 /**
  * The Cassandra implementation to {@link DatabaseManagerFactory}
+ * <br/>
+ * Closing a {@link CassandraColumnManagerFactory} has no effect.
  */
 public class CassandraColumnManagerFactory implements DatabaseManagerFactory {
 
@@ -45,6 +47,9 @@ public CassandraColumnManager apply(String database) {
         return new DefaultCassandraColumnManager(sessionBuilder.build(), database);
     }
 
+    /**
+     * Closing a {@link CassandraColumnManagerFactory} has no effect.
+     */
     @Override
     public void close() {
     }

jnosql-couchbase/pom.xml

@@ -21,7 +21,7 @@
     <parent>
         <groupId>org.eclipse.jnosql.databases</groupId>
         <artifactId>jnosql-databases-parent</artifactId>
-        <version>1.1.5--SNAPSHOT</version>
+        <version>1.1.5-SNAPSHOT</version>
     </parent>
 
     <artifactId>jnosql-couchbase</artifactId>

jnosql-couchbase/src/main/java/org/eclipse/jnosql/databases/couchbase/communication/CouchbaseBucketManager.java

@@ -36,6 +36,8 @@
 
 /**
  * The couchbase implementation to {@link BucketManager}
+ * <br/>
+ * Closing a {@link CouchbaseBucketManager} has no effect.
  */
 public class CouchbaseBucketManager implements BucketManager {
 
@@ -148,6 +150,9 @@ public <K> void delete(Iterable<K> keys) {
         keys.forEach(this::delete);
     }
 
+    /**
+     * Closing a {@link CouchbaseBucketManager} has no effect.
+     */
     @Override
     public void close() {
     }

jnosql-couchbase/src/main/java/org/eclipse/jnosql/databases/couchbase/communication/DefaultCouchbaseDocumentManager.java

@@ -43,7 +43,9 @@
 import static java.util.Objects.requireNonNull;
 
 /**
- * The default implementation of {@link CouchbaseDocumentManager}
+ * The default implementation of {@link CouchbaseDocumentManager}.
+ * <br/>
+ * Closing a {@link DefaultCouchbaseDocumentManager} has no effect.
  */
 class DefaultCouchbaseDocumentManager implements CouchbaseDocumentManager {
 
@@ -225,6 +227,9 @@ public Stream<CommunicationEntity> n1qlQuery(String n1ql) throws NullPointerExce
     }
 
 
+    /**
+     * Closing a {@link DefaultCouchbaseDocumentManager} has no effect.
+     */
     @Override
     public void close() {
     }

jnosql-couchdb/pom.xml

@@ -21,7 +21,7 @@
     <parent>
         <groupId>org.eclipse.jnosql.databases</groupId>
         <artifactId>jnosql-databases-parent</artifactId>
-        <version>1.1.5--SNAPSHOT</version>
+        <version>1.1.5-SNAPSHOT</version>
     </parent>
 
     <artifactId>jnosql-couchdb</artifactId>

jnosql-couchdb/src/main/java/org/eclipse/jnosql/databases/couchdb/communication/CouchDBDocumentManagerFactory.java

@@ -20,6 +20,11 @@
 
 import java.util.Objects;
 
+/**
+ * The couchdb implementation of {@link DatabaseManagerFactory} that returns {@link DefaultCouchDBDocumentManager}.
+ * <br/>
+ * Closing a {@link CouchDBDocumentManagerFactory} has no effect.
+ */
 public class CouchDBDocumentManagerFactory implements DatabaseManagerFactory {
 
 
@@ -39,6 +44,9 @@ public CouchDBDocumentManager apply(String database) {
     }
 
 
+    /**
+     * Closing a {@link CouchDBDocumentManagerFactory} has no effect.
+     */
     @Override
     public void close() {
     }

jnosql-database-commons/pom.xml

@@ -20,7 +20,7 @@
     <parent>
         <groupId>org.eclipse.jnosql.databases</groupId>
         <artifactId>jnosql-databases-parent</artifactId>
-        <version>1.1.5--SNAPSHOT</version>
+        <version>1.1.5-SNAPSHOT</version>
     </parent>
 
     <artifactId>jnosql-database-commons</artifactId>