#80 improve docs

Author: aburmeis

src/main/java/com/arangodb/springframework/repository/query/QueryTransactionBridge.java

@@ -21,12 +21,15 @@
 package com.arangodb.springframework.repository.query;
 
 import org.springframework.core.NamedInheritableThreadLocal;
+import org.springframework.lang.Nullable;
 
 import java.util.Collection;
 import java.util.function.Function;
 
 /**
  * Bridge to postpone late transaction start to be able to inject collections from query side.
+ *
+ * @author Arne Burmeister
  */
 public class QueryTransactionBridge {
 
@@ -64,6 +67,7 @@ public void clearCurrentTransaction() {
      * @see AbstractArangoQuery
      * @see com.arangodb.springframework.repository.SimpleArangoRepository
      */
+    @Nullable
     public String getCurrentTransaction(Collection<String> collections) {
         return CURRENT_TRANSACTION.get().apply(collections);
     }

src/main/java/com/arangodb/springframework/repository/query/StringBasedArangoQuery.java

@@ -45,6 +45,7 @@
  * @author Mark Vollmary
  * @author Christian Lechner
  * @author Michele Rastelli
+ * @author Arne Burmeister
  */
 public class StringBasedArangoQuery extends AbstractArangoQuery {
 	private static final SpelExpressionParser PARSER = new SpelExpressionParser();

src/main/java/com/arangodb/springframework/transaction/ArangoTransactionHolder.java

@@ -34,6 +34,7 @@
  *
  * @see TransactionSynchronizationManager#bindResource(Object, Object)
  * @see ArangoTransactionObject
+ * @author Arne Burmeister
  */
 class ArangoTransactionHolder {
 

src/main/java/com/arangodb/springframework/transaction/ArangoTransactionManagementConfigurer.java

@@ -32,7 +32,9 @@
  * To enable stream transactions for Arango Spring Data, create a
  * {@link org.springframework.context.annotation.Configuration} class annotated with
  * {@link org.springframework.transaction.annotation.EnableTransactionManagement} and
- * {@link org.springframework.context.annotation.Import} this one.
+ *{@link org.springframework.context.annotation.Import} this one.
+ *
+ * @author Arne Burmeister
  */
 public class ArangoTransactionManagementConfigurer implements TransactionManagementConfigurer {
 

src/main/java/com/arangodb/springframework/transaction/ArangoTransactionManager.java

@@ -45,6 +45,8 @@
  * {@linkplain TransactionDefinition#getIsolationLevel() isolation}
  * {@linkplain TransactionDefinition#ISOLATION_SERIALIZABLE serializable} are
  * supported.
+ *
+ * @author Arne Burmeister
  */
 public class ArangoTransactionManager extends AbstractPlatformTransactionManager implements InitializingBean {
 

src/main/java/com/arangodb/springframework/transaction/ArangoTransactionObject.java

@@ -41,8 +41,10 @@
 import static org.springframework.transaction.TransactionDefinition.TIMEOUT_DEFAULT;
 
 /**
- * Transaction object created by
- * {@link ArangoTransactionManager#doGetTransaction()}.
+ * Transaction object used for {@link org.springframework.transaction.support.DefaultTransactionStatus#getTransaction()}.
+ *
+ * @see ArangoTransactionManager#doGetTransaction()
+ * @author Arne Burmeister
  */
 class ArangoTransactionObject implements SmartTransactionObject {
 

src/main/java/com/arangodb/springframework/transaction/TransactionAttributeTemplate.java

@@ -20,6 +20,7 @@
 
 package com.arangodb.springframework.transaction;
 
+import org.springframework.lang.Nullable;
 import org.springframework.transaction.PlatformTransactionManager;
 import org.springframework.transaction.TransactionDefinition;
 import org.springframework.transaction.interceptor.TransactionAttribute;
@@ -34,6 +35,7 @@
  * transaction exception handling in combination with a transaction manager using labels.
  *
  * @see ArangoTransactionManager
+ * @author Arne Burmeister
  */
 public class TransactionAttributeTemplate extends TransactionTemplate implements TransactionAttribute {
 
@@ -61,11 +63,12 @@ public TransactionAttributeTemplate(PlatformTransactionManager transactionManage
     }
 
     @Override
+    @Nullable
     public String getQualifier() {
         return qualifier;
     }
 
-    public void setQualifier(String qualifier) {
+    public void setQualifier(@Nullable String qualifier) {
         this.qualifier = qualifier;
     }
 

src/main/java/com/arangodb/springframework/transaction/package-info.java

@@ -0,0 +1,4 @@
+@NonNullApi
+package com.arangodb.springframework.transaction;
+
+import org.springframework.lang.NonNullApi;