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/core/packet/IPacket.java b/src/main/java/net/onrc/onos/core/packet/IPacket.java
index 9cbba4d..27be84e 100644
--- a/src/main/java/net/onrc/onos/core/packet/IPacket.java
+++ b/src/main/java/net/onrc/onos/core/packet/IPacket.java
@@ -22,24 +22,32 @@
*/
public interface IPacket {
/**
- * @return
+ * Gets the payload of the packet.
+ *
+ * @return the payload of the packet
*/
public IPacket getPayload();
/**
- * @param packet
- * @return
+ * Sets the payload of the packet.
+ *
+ * @param packet the inner packet to set as the payload
+ * @return this IPacket
*/
public IPacket setPayload(IPacket packet);
/**
- * @return
+ * Gets the parent (outer) packet.
+ *
+ * @return the parent packet
*/
public IPacket getParent();
/**
- * @param packet
- * @return
+ * Sets the parent (outer) packet.
+ *
+ * @param packet the parent packet
+ * @return this IPacket
*/
public IPacket setParent(IPacket packet);
@@ -69,7 +77,7 @@
/**
* Clone this packet and its payload packet but not its parent.
*
- * @return
+ * @return a cloned copy of this packet
*/
public Object clone();
}