Document RaftRPC 19/34619/5
authorRobert Varga <rovarga@cisco.com>
Sun, 14 Feb 2016 00:36:31 +0000 (01:36 +0100)
committerRobert Varga <rovarga@cisco.com>
Mon, 15 Feb 2016 15:53:14 +0000 (16:53 +0100)
Add some basic javadocs.

Change-Id: I1cd1a37e3979c497705baf3a2b508c058f1022ec
Signed-off-by: Robert Varga <rovarga@cisco.com>
opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/RaftRPC.java

index 10d9998..4d12d35 100644 (file)
@@ -10,6 +10,14 @@ package org.opendaylight.controller.cluster.raft.messages;
 
 import java.io.Serializable;
 
+/**
+ * Interface implemented by all requests exchanged in the Raft protocol.
+ */
 public interface RaftRPC extends Serializable {
+    /**
+     * Return the term in which this call is being made.
+     *
+     * @return The term ID
+     */
     public long getTerm();
 }