javadoc fixes
Change-Id: I3b4fc2d99f42b2413a535fb411b9c19bdd186ad8
diff --git a/utils/misc/src/main/java/org/onlab/graph/MutableAdjacencyListsGraph.java b/utils/misc/src/main/java/org/onlab/graph/MutableAdjacencyListsGraph.java
index 299ec46..044a60d 100644
--- a/utils/misc/src/main/java/org/onlab/graph/MutableAdjacencyListsGraph.java
+++ b/utils/misc/src/main/java/org/onlab/graph/MutableAdjacencyListsGraph.java
@@ -38,8 +38,8 @@
/**
* Creates a graph comprising of the specified vertexes and edges.
*
- * @param vertexes set of graph vertexes
- * @param edges set of graph edges
+ * @param vertex set of graph vertexes
+ * @param edge set of graph edges
*/
public MutableAdjacencyListsGraph(Set<V> vertex, Set<E> edge) {
vertexes.addAll(vertex);
diff --git a/utils/misc/src/main/java/org/onlab/packet/ARP.java b/utils/misc/src/main/java/org/onlab/packet/ARP.java
index 91713c1..86fb289 100644
--- a/utils/misc/src/main/java/org/onlab/packet/ARP.java
+++ b/utils/misc/src/main/java/org/onlab/packet/ARP.java
@@ -55,6 +55,7 @@
/**
* @param hwType
* the hardwareType to set
+ * @return this
*/
public ARP setHardwareType(final short hwType) {
this.hardwareType = hwType;
@@ -71,6 +72,7 @@
/**
* @param protoType
* the protocolType to set
+ * @return this
*/
public ARP setProtocolType(final short protoType) {
this.protocolType = protoType;
@@ -87,6 +89,7 @@
/**
* @param hwAddressLength
* the hardwareAddressLength to set
+ * @return this
*/
public ARP setHardwareAddressLength(final byte hwAddressLength) {
this.hardwareAddressLength = hwAddressLength;
@@ -103,6 +106,7 @@
/**
* @param protoAddressLength
* the protocolAddressLength to set
+ * @return this
*/
public ARP setProtocolAddressLength(final byte protoAddressLength) {
this.protocolAddressLength = protoAddressLength;
@@ -119,6 +123,7 @@
/**
* @param op
* the opCode to set
+ * @return this
*/
public ARP setOpCode(final short op) {
this.opCode = op;
@@ -135,6 +140,7 @@
/**
* @param senderHWAddress
* the senderHardwareAddress to set
+ * @return this
*/
public ARP setSenderHardwareAddress(final byte[] senderHWAddress) {
this.senderHardwareAddress = senderHWAddress;
@@ -151,6 +157,7 @@
/**
* @param senderProtoAddress
* the senderProtocolAddress to set
+ * @return this
*/
public ARP setSenderProtocolAddress(final byte[] senderProtoAddress) {
this.senderProtocolAddress = senderProtoAddress;
@@ -173,6 +180,7 @@
/**
* @param targetHWAddress
* the targetHardwareAddress to set
+ * @return this
*/
public ARP setTargetHardwareAddress(final byte[] targetHWAddress) {
this.targetHardwareAddress = targetHWAddress;
@@ -206,6 +214,7 @@
/**
* @param targetProtoAddress
* the targetProtocolAddress to set
+ * @return this
*/
public ARP setTargetProtocolAddress(final byte[] targetProtoAddress) {
this.targetProtocolAddress = targetProtoAddress;
diff --git a/utils/misc/src/main/java/org/onlab/packet/Data.java b/utils/misc/src/main/java/org/onlab/packet/Data.java
index 311cc93..f3a1092 100644
--- a/utils/misc/src/main/java/org/onlab/packet/Data.java
+++ b/utils/misc/src/main/java/org/onlab/packet/Data.java
@@ -33,7 +33,7 @@
}
/**
- * @param data
+ * @param data the data
*/
public Data(final byte[] data) {
this.data = data;
@@ -49,6 +49,7 @@
/**
* @param data
* the data to set
+ * @return self
*/
public Data setData(final byte[] data) {
this.data = data;
diff --git a/utils/misc/src/main/java/org/onlab/packet/IPacket.java b/utils/misc/src/main/java/org/onlab/packet/IPacket.java
index f1f01e4..6e2f2a0 100644
--- a/utils/misc/src/main/java/org/onlab/packet/IPacket.java
+++ b/utils/misc/src/main/java/org/onlab/packet/IPacket.java
@@ -64,7 +64,7 @@
/**
* Deserializes this packet layer and all possible payloads.
*
- * @param data
+ * @param data bytes to deserialize
* @param offset
* offset to start deserializing from
* @param length
diff --git a/utils/misc/src/main/java/org/onlab/util/HexString.java b/utils/misc/src/main/java/org/onlab/util/HexString.java
index 4e46a25..3e9ae03 100644
--- a/utils/misc/src/main/java/org/onlab/util/HexString.java
+++ b/utils/misc/src/main/java/org/onlab/util/HexString.java
@@ -24,7 +24,7 @@
/**
* Convert a string of bytes to a ':' separated hex string.
*
- * @param bytes
+ * @param bytes string of bytes to convert
* @return "0f:ca:fe:de:ad:be:ef"
*/
public static String toHexString(final byte[] bytes) {
diff --git a/utils/netty/src/main/java/org/onlab/netty/MessagingService.java b/utils/netty/src/main/java/org/onlab/netty/MessagingService.java
index 8c4f4ee..9277448 100644
--- a/utils/netty/src/main/java/org/onlab/netty/MessagingService.java
+++ b/utils/netty/src/main/java/org/onlab/netty/MessagingService.java
@@ -29,7 +29,7 @@
* @param ep end point to send the message to.
* @param type type of message.
* @param payload message payload bytes.
- * @throws IOException
+ * @throws IOException when I/O exception of some sort has occurred
*/
public void sendAsync(Endpoint ep, String type, byte[] payload) throws IOException;
@@ -39,7 +39,7 @@
* @param type type of message.
* @param payload message payload.
* @return a response future
- * @throws IOException
+ * @throws IOException when I/O exception of some sort has occurred
*/
public ListenableFuture<byte[]> sendAndReceive(Endpoint ep, String type, byte[] payload) throws IOException;
diff --git a/utils/nio/src/main/java/org/onlab/nio/IOLoop.java b/utils/nio/src/main/java/org/onlab/nio/IOLoop.java
index 9d417ac..106df7b 100644
--- a/utils/nio/src/main/java/org/onlab/nio/IOLoop.java
+++ b/utils/nio/src/main/java/org/onlab/nio/IOLoop.java
@@ -107,6 +107,7 @@
* Completes connection request pending on the given selection key.
*
* @param key selection key holding the pending connect operation.
+ * @throws IOException when I/O exception of some sort has occurred
*/
protected void connect(SelectionKey key) throws IOException {
SocketChannel ch = (SocketChannel) key.channel();
diff --git a/utils/nio/src/main/java/org/onlab/nio/SelectorLoop.java b/utils/nio/src/main/java/org/onlab/nio/SelectorLoop.java
index 4f3220d..605e0a9 100644
--- a/utils/nio/src/main/java/org/onlab/nio/SelectorLoop.java
+++ b/utils/nio/src/main/java/org/onlab/nio/SelectorLoop.java
@@ -74,6 +74,7 @@
/**
* Indicates that the loop is marked to run.
+ * @return true if the loop is marked to run
*/
protected boolean isRunning() {
return state == State.STARTED || state == State.STARTING;
diff --git a/utils/thirdparty/src/main/java/org/onlab/thirdparty/OnlabThirdparty.java b/utils/thirdparty/src/main/java/org/onlab/thirdparty/OnlabThirdparty.java
index 9c9b03f..7405558 100644
--- a/utils/thirdparty/src/main/java/org/onlab/thirdparty/OnlabThirdparty.java
+++ b/utils/thirdparty/src/main/java/org/onlab/thirdparty/OnlabThirdparty.java
@@ -18,7 +18,7 @@
/**
* Empty class required to get the onlab-thirdparty module to build properly.
- * <p/>
+ *
* TODO Figure out how to remove this.
*/
public class OnlabThirdparty {