Fix javadoc warnings in mdsal-binding-util

We have a few undocumented generic parameters, fix that up.

Change-Id: Ifbe06d528b9333026c1bdc0bd6af73570940ade0
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/binding/mdsal-binding-util/src/main/java/org/opendaylight/mdsal/binding/util/ManagedTransactionFactory.java b/binding/mdsal-binding-util/src/main/java/org/opendaylight/mdsal/binding/util/ManagedTransactionFactory.java
index f94f56d03bd7ec27248a77a552f8e93223a23b85..76e618a72e4ecece8cf4a2fc71e35c80e7a6cb46 100644 (file)
--- a/binding/mdsal-binding-util/src/main/java/org/opendaylight/mdsal/binding/util/ManagedTransactionFactory.java
+++ b/binding/mdsal-binding-util/src/main/java/org/opendaylight/mdsal/binding/util/ManagedTransactionFactory.java
@@ -38,6 +38,9 @@ public interface ManagedTransactionFactory {
      * <p>The provided transaction is specific to the given logical datastore type and cannot be used for any
      * other.
      *
+     * @param <D> datastore type
+     * @param <E> thrown exception type
+     * @param <R> result type
      * @param datastoreType the {@link Datastore} type that will be accessed
      * @param txFunction the {@link InterruptibleCheckedFunction} that needs a new read transaction
      * @return the result of the function.
@@ -59,6 +62,9 @@ public interface ManagedTransactionFactory {
      * <p>The provided transaction is specific to the given logical datastore type and cannot be used for any
      * other.
      *
+     * @param <D> datastore type
+     * @param <E> thrown exception type
+     * @param <R> result type
      * @param datastoreType the {@link Datastore} type that will be accessed
      * @param txFunction the {@link InterruptibleCheckedFunction} that needs a new read transaction
      * @return the result of the function.
@@ -88,6 +94,9 @@ public interface ManagedTransactionFactory {
      * {@link CompletionStage}
      * (but better NOT by using the blocking {@link Future#get()} on it).
      *
+     * @param <D> datastore type
+     * @param <E> thrown exception type
+     * @param <R> result type
      * @param datastoreType the {@link Datastore} type that will be accessed
      * @param txFunction the {@link InterruptibleCheckedFunction} that needs a new read-write transaction
      * @return the {@link FluentFuture} returned by {@link ReadWriteTransaction#commit()}, or a failed future with an
@@ -109,6 +118,8 @@ public interface ManagedTransactionFactory {
      * <p>The provided transaction is specific to the given logical datastore type and cannot be used for any
      * other.
      *
+     * @param <D> datastore type
+     * @param <E> thrown exception type
      * @param datastoreType the {@link Datastore} type that will be accessed
      * @param txConsumer the {@link InterruptibleCheckedFunction} that needs a new read transaction
      * @throws E if an error occurs.
@@ -129,6 +140,8 @@ public interface ManagedTransactionFactory {
      * <p>The provided transaction is specific to the given logical datastore type and cannot be used for any
      * other.
      *
+     * @param <D> datastore type
+     * @param <E> thrown exception type
      * @param datastoreType the {@link Datastore} type that will be accessed
      * @param txConsumer the {@link InterruptibleCheckedFunction} that needs a new read transaction
      * @throws E if an error occurs.
@@ -157,6 +170,8 @@ public interface ManagedTransactionFactory {
      * {@link CompletionStage}
      * (but better NOT by using the blocking {@link Future#get()} on it).
      *
+     * @param <D> datastore type
+     * @param <E> thrown exception type
      * @param datastoreType the {@link Datastore} type that will be accessed
      * @param txConsumer the {@link InterruptibleCheckedConsumer} that needs a new read-write transaction
      * @return the {@link FluentFuture} returned by {@link ReadWriteTransaction#commit()}, or a failed future with an
@@ -188,6 +203,8 @@ public interface ManagedTransactionFactory {
      * {@link CompletionStage}
      * (but better NOT by using the blocking {@link Future#get()} on it).
      *
+     * @param <D> datastore type
+     * @param <E> thrown exception type
      * @param datastoreType the {@link Datastore} type that will be accessed
      * @param txConsumer the {@link InterruptibleCheckedConsumer} that needs a new write only transaction
      * @return the {@link FluentFuture} returned by {@link WriteTransaction#commit()}, or a failed future with an

diff --git a/binding/mdsal-binding-util/src/main/java/org/opendaylight/mdsal/binding/util/TypedReadTransaction.java b/binding/mdsal-binding-util/src/main/java/org/opendaylight/mdsal/binding/util/TypedReadTransaction.java
index c6556c6ec7777a681c5fda7aa7d806c0802aa266..90b3d8e3c92bff94e3477b7afa9e2d258fa18f4b 100644 (file)
--- a/binding/mdsal-binding-util/src/main/java/org/opendaylight/mdsal/binding/util/TypedReadTransaction.java
+++ b/binding/mdsal-binding-util/src/main/java/org/opendaylight/mdsal/binding/util/TypedReadTransaction.java
@@ -53,6 +53,7 @@ public interface TypedReadTransaction<D extends Datastore> extends Transaction {
      * Executes a {@link QueryExpression}.
      *
      * @param query Query to execute
+     * @param <T> The type of the expected object
      * @return a FluentFuture containing the result of the query. The Future blocks until the operation is complete.
      *         Once complete:
      *         <ul>