Clarify the event listener failure documentation

Change-Id: Ic1f79e926e940a9d3a418b891d28d58603d2d31e
Signed-off-by: Stephen Kitt <skitt@redhat.com>

diff --git a/common/mdsal-common-api/src/main/java/org/opendaylight/mdsal/common/api/TransactionChainListener.java b/common/mdsal-common-api/src/main/java/org/opendaylight/mdsal/common/api/TransactionChainListener.java
index 1e5a74175e29ee3485b7209eeaf72a2650a9e891..9137c9af10abd37753733c324678dfa30bb5473e 100644 (file)
--- a/common/mdsal-common-api/src/main/java/org/opendaylight/mdsal/common/api/TransactionChainListener.java
+++ b/common/mdsal-common-api/src/main/java/org/opendaylight/mdsal/common/api/TransactionChainListener.java
@@ -14,8 +14,10 @@ import java.util.EventListener;
  */
 public interface TransactionChainListener extends EventListener {
     /**
-     * Invoked if when a transaction in the chain fails. All other transactions are automatically cancelled by the time
-     * this notification is invoked. Implementations should invoke chain.close() to close the chain.
+     * Invoked if when a transaction in the chain fails. All transactions submitted after the failed transaction, in the
+     * chain, are automatically cancelled by the time this notification is invoked. Open transactions need to be closed
+     * or cancelled.
+     * Implementations should invoke chain.close() to close the chain.
      *
      * @param chain Transaction chain which failed
      * @param transaction Transaction which caused the chain to fail