Fix javadocs and enable doclint

[controller.git] / opendaylight / md-sal / sal-binding-api / src / main / java / org / opendaylight / controller / sal / binding / api / data / DataModificationTransaction.java

diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/DataModificationTransaction.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/DataModificationTransaction.java
index 0c250fdbee4c2454d0d9c1afa981ef71b4c05acc..7e72bd488fdc9789037b351e29c6204211fe93ec 100644 (file)
--- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/DataModificationTransaction.java
+++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/DataModificationTransaction.java
@@ -9,7 +9,6 @@ package org.opendaylight.controller.sal.binding.api.data;
 
 import java.util.EventListener;
 import java.util.concurrent.Future;
-
 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
 import org.opendaylight.controller.md.sal.common.api.data.DataModification;
 import org.opendaylight.yangtools.concepts.ListenerRegistration;
@@ -18,18 +17,15 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 import org.opendaylight.yangtools.yang.common.RpcResult;
 
 /**
- *
- *
  * @deprecated Replaced by more specific transaction types. Please use
- *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadOnlyTransaction(),
- *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadWriteTransaction()
+ *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadOnlyTransaction()},
+ *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadWriteTransaction()}
  *          or
- *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newWriteOnlyTransaction().
- *
- *
+ *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newWriteOnlyTransaction()}.
  */
 @Deprecated
-public interface DataModificationTransaction extends DataModification<InstanceIdentifier<? extends DataObject>, DataObject> {
+public interface DataModificationTransaction extends
+        DataModification<InstanceIdentifier<? extends DataObject>, DataObject> {
     /**
      * Returns an unique identifier for transaction
      *
@@ -41,7 +37,7 @@ public interface DataModificationTransaction extends DataModification<InstanceId
      * Initiates a two-phase commit of candidate data.
      *
      * <p>
-     * The {@link Consumer} could initiate a commit of candidate data
+     * The Consumer could initiate a commit of candidate data
      *
      * <p>
      * The successful commit changes the state of the system and may affect
@@ -49,15 +45,11 @@ public interface DataModificationTransaction extends DataModification<InstanceId
      *
      * <p>
      * The effects of successful commit of data are described in the
-     * specifications and YANG models describing the {@link Provider} components
-     * of controller. It is assumed that {@link Consumer} has an understanding
+     * specifications and YANG models describing the Provider components
+     * of controller. It is assumed that the Consumer has an understanding
      * of this changes.
      *
      *
-     * @see org.opendaylight.controller.md.sal.common.api.data.DataCommitHandler for further information how two-phase commit is
-     *      processed.
-     * @param store
-     *            Identifier of the store, where commit should occur.
      * @return Result of the commit, containing success information or list of
      *         encountered errors, if commit was not successful.
      */
@@ -75,7 +67,7 @@ public interface DataModificationTransaction extends DataModification<InstanceId
     /**
      * Listener for transaction state changes
      */
-    public interface DataTransactionListener extends EventListener {
+    interface DataTransactionListener extends EventListener {
         /**
          * Callback is invoked after each transaction status change.
          *