Cleaned up a slew of Javadoc errors in preparation for switch over to Java 8.
diff --git a/utils/misc/src/main/java/org/onlab/packet/IpAddress.java b/utils/misc/src/main/java/org/onlab/packet/IpAddress.java
index 487fb5b..33be226 100644
--- a/utils/misc/src/main/java/org/onlab/packet/IpAddress.java
+++ b/utils/misc/src/main/java/org/onlab/packet/IpAddress.java
@@ -76,10 +76,10 @@
/**
* Converts a byte array and a given offset from the beginning of the
* array into an IP address.
- * <p/>
+ * <p>
* The IP address is stored in network byte order (i.e., the most
* significant byte first).
- *
+ * </p>
* @param value the value to use
* @param offset the offset in bytes from the beginning of the byte array
* @return an IP address
diff --git a/utils/misc/src/main/java/org/onlab/packet/IpPrefix.java b/utils/misc/src/main/java/org/onlab/packet/IpPrefix.java
index f15946a..180b771 100644
--- a/utils/misc/src/main/java/org/onlab/packet/IpPrefix.java
+++ b/utils/misc/src/main/java/org/onlab/packet/IpPrefix.java
@@ -17,13 +17,15 @@
import java.util.Objects;
+// TODO: Add support for IPv6 as well.
+
/**
- * A class representing an IP prefix.
- * TODO: Add support for IPv6 as well.
- * <p/>
- * A prefix consists of an IP address and a subnet mask.
+ * A class representing an IP prefix. A prefix consists of an IP address and
+ * a subnet mask.
+ * <p>
* NOTE: The stored IP address in the result IP prefix is masked to
* contain zeroes in all bits after the prefix length.
+ * </p>
*/
public final class IpPrefix {
// Maximum network mask length
@@ -97,7 +99,7 @@
* Converts a CIDR (slash) notation string (e.g., "10.1.0.0/16") into an
* IP prefix.
*
- * @param value an IP prefix in string form, e.g. "10.1.0.0/16"
+ * @param address an IP prefix in string form, e.g. "10.1.0.0/16"
* @return an IP prefix
*/
public static IpPrefix valueOf(String address) {
diff --git a/utils/misc/src/main/java/org/onlab/util/NewConcurrentHashMap.java b/utils/misc/src/main/java/org/onlab/util/NewConcurrentHashMap.java
index 3b44ad4..2d222ea 100644
--- a/utils/misc/src/main/java/org/onlab/util/NewConcurrentHashMap.java
+++ b/utils/misc/src/main/java/org/onlab/util/NewConcurrentHashMap.java
@@ -24,8 +24,8 @@
* Creates an instance of new ConcurrentHashMap on each {@link #get()} call.
* <p>
* To be used with
- * {@link org.apache.commons.lang3.concurrent.ConcurrentUtils#createIfAbsent()
- * ConcurrentUtils#createIfAbsent}
+ * {@link org.apache.commons.lang3.concurrent.ConcurrentUtils#createIfAbsent}
+ * </p>
*
* @param <K> ConcurrentHashMap key type
* @param <V> ConcurrentHashMap value type
diff --git a/utils/netty/src/main/java/org/onlab/netty/MessageHandler.java b/utils/netty/src/main/java/org/onlab/netty/MessageHandler.java
index fe91fb2..a87d8fc 100644
--- a/utils/netty/src/main/java/org/onlab/netty/MessageHandler.java
+++ b/utils/netty/src/main/java/org/onlab/netty/MessageHandler.java
@@ -24,8 +24,9 @@
/**
* Handles the message.
+ *
* @param message message.
- * @throws IOException.
+ * @throws IOException if an error is encountered handling the message
*/
public void handle(Message message) throws IOException;
}
diff --git a/utils/nio/src/main/java/org/onlab/nio/MessageStream.java b/utils/nio/src/main/java/org/onlab/nio/MessageStream.java
index 302b049..a19e8aa 100644
--- a/utils/nio/src/main/java/org/onlab/nio/MessageStream.java
+++ b/utils/nio/src/main/java/org/onlab/nio/MessageStream.java
@@ -318,10 +318,10 @@
* Attempts to flush data, internal stream state and channel availability
* permitting. Invoked by the driver I/O loop during handling of writable
* selection key.
- * <p/>
+ * <p>
* Resets the internal state flags {@code writeOccurred} and
* {@code writePending}.
- *
+ * </p>
* @throws IOException if implicit flush failed
*/
void flushIfPossible() throws IOException {