Fix warnings and javadocs in sal-akka-raft

[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..a09a0a23ac40299bf917a7b220bb0aa2316d1141 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
@@ -11,36 +11,34 @@ package org.opendaylight.controller.cluster.raft;
 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
 
 /**
- * Represents one entry in the replicated log
+ * Represents one entry in the replicated log.
  */
 public interface ReplicatedLogEntry {
     /**
-     * The data stored in that entry
+     * Returns the payload/data to be replicated.
      *
-     * @return
+     * @return the payload/data
      */
     Payload getData();
 
     /**
-     * The term stored in that entry
+     * Returns the term of the entry.
      *
-     * @return
+     * @return the term
      */
     long getTerm();
 
     /**
-     * The index of the entry
+     * Returns the index of the entry.
      *
-     * @return
+     * @return the index
      */
     long getIndex();
 
     /**
-     * The size of the entry in bytes.
+     * Returns the size of the entry in bytes. An approximate number may be good enough.
      *
-     * An approximate number may be good enough.
-     *
-     * @return
+     * @return the size of the entry in bytes.
      */
     int size();
 }