Enable checkstyle Javadoc Comment Style rule
Turn on the Javadoc Comment Style rule and fix
any violations that come up. This is related to
requiring javadoc description comments to end
with a '.'
Change-Id: I19cf1b9f00d3040987e0b4c8b39461e2e0ad66b5
diff --git a/src/main/java/net/onrc/onos/core/datastore/IKVClient.java b/src/main/java/net/onrc/onos/core/datastore/IKVClient.java
index 50bdf92..0fa1cbd 100644
--- a/src/main/java/net/onrc/onos/core/datastore/IKVClient.java
+++ b/src/main/java/net/onrc/onos/core/datastore/IKVClient.java
@@ -6,7 +6,7 @@
import net.onrc.onos.core.datastore.IKVTable.IKVEntry;
/**
- * Interface for a client class used to access the Key-Value store
+ * Interface for a client class used to access the Key-Value store.
*/
public interface IKVClient {
@@ -85,7 +85,7 @@
// give an option to improve performance on some backends.
/**
- * Remove an existing Key-Value entry in table
+ * Remove an existing Key-Value entry in table.
*
* @param tableId
* @param key
@@ -98,7 +98,7 @@
throws ObjectDoesntExistException, WrongVersionException;
/**
- * Remove a Key-Value entry in table
+ * Remove a Key-Value entry in table.
*
* @param tableId
* @param key
@@ -134,7 +134,7 @@
public IMultiEntryOperation forceDeleteOp(IKVTableID tableId, byte[] key);
/**
- * Batch delete operation
+ * Batch delete operation.
*
* @param ops delete operations
* @return true if failed operation exists
@@ -142,7 +142,7 @@
public boolean multiDelete(final Collection<IMultiEntryOperation> ops);
/**
- * Batch write operation
+ * Batch write operation.
*
* @param ops write operations
* @return true if failed operation exists
@@ -150,7 +150,7 @@
public boolean multiWrite(final List<IMultiEntryOperation> ops);
/**
- * Batch read operation
+ * Batch read operation.
*
* @param ops read operations
* @return true if failed operation exists
diff --git a/src/main/java/net/onrc/onos/core/datastore/IKVTable.java b/src/main/java/net/onrc/onos/core/datastore/IKVTable.java
index 95e0027..87fee25 100644
--- a/src/main/java/net/onrc/onos/core/datastore/IKVTable.java
+++ b/src/main/java/net/onrc/onos/core/datastore/IKVTable.java
@@ -2,7 +2,7 @@
/**
- * Interface for a class to represent a Table in a Key-Value store
+ * Interface for a class to represent a Table in a Key-Value store.
*/
public interface IKVTable {
@@ -83,7 +83,7 @@
throws ObjectDoesntExistException;
/**
- * Remove an existing Key-Value entry in table
+ * Remove an existing Key-Value entry in table.
*
* @param key
* @param version expected version in the data store
@@ -95,7 +95,7 @@
throws ObjectDoesntExistException, WrongVersionException;
/**
- * Remove a Key-Value entry in table
+ * Remove a Key-Value entry in table.
*
* @param key
* @return version of removed object or VERSION_NONEXISTENT, if it did not exist.
diff --git a/src/main/java/net/onrc/onos/core/datastore/ramcloud/RCTable.java b/src/main/java/net/onrc/onos/core/datastore/ramcloud/RCTable.java
index e5a6675..f7bafd5 100644
--- a/src/main/java/net/onrc/onos/core/datastore/ramcloud/RCTable.java
+++ b/src/main/java/net/onrc/onos/core/datastore/ramcloud/RCTable.java
@@ -10,7 +10,7 @@
import org.slf4j.LoggerFactory;
/**
- * Class to represent a Table in RAMCloud
+ * Class to represent a Table in RAMCloud.
*/
public class RCTable implements IKVTable {
@SuppressWarnings("unused")
diff --git a/src/main/java/net/onrc/onos/core/datastore/utils/KVObject.java b/src/main/java/net/onrc/onos/core/datastore/utils/KVObject.java
index c696bd7..568cfc7 100644
--- a/src/main/java/net/onrc/onos/core/datastore/utils/KVObject.java
+++ b/src/main/java/net/onrc/onos/core/datastore/utils/KVObject.java
@@ -54,7 +54,7 @@
private long version;
/**
- * Map to store user-defined properties
+ * Map to store user-defined properties.
*/
private Map<Object, Object> propertyMap;
@@ -333,7 +333,7 @@
}
/**
- * TODO Extract common interface
+ * TODO Extract common interface.
*/
public static class WriteOp implements IMultiObjectOperation, IModifiableMultiEntryOperation {