From: Robert Varga <rovarga@cisco.com>
Date: Sun, 14 Feb 2016 00:36:31 +0000 (+0100)
Subject: Document RaftRPC
X-Git-Tag: release/boron~366
X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=commitdiff_plain;h=2cce7e4ab6ecad4710cf26f41bfea607e94ae810

Document RaftRPC

Add some basic javadocs.

Change-Id: I1cd1a37e3979c497705baf3a2b508c058f1022ec
Signed-off-by: Robert Varga <rovarga@cisco.com>
---

diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/RaftRPC.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/RaftRPC.java
index 10d99988d8..4d12d3543f 100644
--- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/RaftRPC.java
+++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/RaftRPC.java
@@ -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();
 }