Cleaned up warnings reported by the Javadoc tool.
Javadoc reports warnings for things such as missing return descriptions,
missing or wrong parameters, invalid tags.
Note: I didn't touch any of the warnings in the OpenflowJ code.
Change-Id: I7234f617e092b489fad599196fc9cbe78f7e2db1
diff --git a/src/main/java/net/onrc/onos/apps/sdnip/IPatriciaTree.java b/src/main/java/net/onrc/onos/apps/sdnip/IPatriciaTree.java
index fa548b2..21cb823 100644
--- a/src/main/java/net/onrc/onos/apps/sdnip/IPatriciaTree.java
+++ b/src/main/java/net/onrc/onos/apps/sdnip/IPatriciaTree.java
@@ -78,7 +78,7 @@
/**
* Represents an entry in the patricia tree. The {@code Entry} is a mapping
- * from {@link Prefix} to a {@link V} value object.
+ * from {@link Prefix} to a value object of type {@code V}.
*
* @param <V> the class of objects stored in the tree
*/
diff --git a/src/main/java/net/onrc/onos/apps/sdnip/Interface.java b/src/main/java/net/onrc/onos/apps/sdnip/Interface.java
index 15abb1f..b906ba6 100644
--- a/src/main/java/net/onrc/onos/apps/sdnip/Interface.java
+++ b/src/main/java/net/onrc/onos/apps/sdnip/Interface.java
@@ -25,7 +25,7 @@
*
* Each interface has a name, which is a unique identifying String that is used
* to reference this interface in the configuration (for example, to map
- * {@link BgpPeers} to {@code Interfaces}.
+ * {@link BgpPeer}s to {@code Interfaces}.
*/
public class Interface {
private final String name;
diff --git a/src/main/java/net/onrc/onos/apps/sdnip/Path.java b/src/main/java/net/onrc/onos/apps/sdnip/Path.java
index 7772775..28b632b 100644
--- a/src/main/java/net/onrc/onos/apps/sdnip/Path.java
+++ b/src/main/java/net/onrc/onos/apps/sdnip/Path.java
@@ -13,7 +13,7 @@
* The {@link Path} object doesn't contain lists of hops along the path.
* Rather, it contains details about the egress {@link Interface} and
* {@code next_hop} IP address. Implicitly, it represents paths from every
- * other ingress port to the {@Interface}.
+ * other ingress port to the {@code Interface}.
* <p/>
* Once flow mods are pushed to realize the path in the network, the
* {@link Path} object will contain a list of pushed flow mods. These are used
@@ -95,7 +95,7 @@
* Gets the list of flow mods that were installed to realize this path in
* the network.
*
- * @return the list of {@link PushedFlowMods}
+ * @return the list of {@link PushedFlowMod}s
*/
public List<PushedFlowMod> getFlowMods() {
return Collections.unmodifiableList(flowMods);
@@ -105,7 +105,7 @@
* Sets the list of flow mods that were installed to realize this path in
* the network.
*
- * @param flowMods the list of {@link PushedFlowMods}
+ * @param flowMods the list of {@link PushedFlowMod}s
*/
public void setFlowMods(List<PushedFlowMod> flowMods) {
this.flowMods = flowMods;