CLEANUP : Fix javadoc warnings in sal-akka-raft code

[controller.git] / opendaylight / md-sal / sal-akka-raft / src / main / java / org / opendaylight / controller / cluster / raft / ClientRequestTracker.java

diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ClientRequestTracker.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ClientRequestTracker.java
index 4972b348ff4d98d8e0d1eb2b1135ccf53f837768..af6f1d453ab59e6d4a1dc8212e9678c17eb01a73 100644 (file)
--- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ClientRequestTracker.java
+++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ClientRequestTracker.java
@@ -12,22 +12,21 @@ import akka.actor.ActorRef;
 
 public interface ClientRequestTracker {
     /**
-     * The client actor who is waiting for a response
      *
-     * @return
+     * @return the client actor that should be sent a response when consensus is achieved
      */
     ActorRef getClientActor();
 
     /**
      *
-     * @return
+     * @return the identifier of the object that is to be replicated. For example a transaction identifier in the case
+     * of a transaction
      */
     String getIdentifier();
 
     /**
-     * The index of the log entry which needs to be replicated
      *
-     * @return
+     * @return the index of the log entry that is to be replicated
      */
     long getIndex();