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 / ReplicatedLogEntry.java

diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ReplicatedLogEntry.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ReplicatedLogEntry.java
index 19796097364f3a2d321b11edb281834055f97a16..1bced2404dea9161ae64dc2f0cee0d37e0a2d677 100644 (file)
--- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ReplicatedLogEntry.java
+++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ReplicatedLogEntry.java
@@ -15,32 +15,26 @@ import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payloa
  */
 public interface ReplicatedLogEntry {
     /**
-     * The data stored in that entry
      *
-     * @return
+     * @return The payload/data to be replicated
      */
     Payload getData();
 
     /**
-     * The term stored in that entry
      *
-     * @return
+     * @return The term of the entry
      */
     long getTerm();
 
     /**
-     * The index of the entry
      *
-     * @return
+     * @return The index of the entry
      */
     long getIndex();
 
     /**
-     * The size of the entry in bytes.
      *
-     * An approximate number may be good enough.
-     *
-     * @return
+     * @return The size of the entry in bytes. An approximate number may be good enough.
      */
     int size();
 }