Fixed javadoc warnings in slew of legacy code. We need to keep up on this; the o…

…ld stuff is pretty sloppy.

@@ -632,7 +632,7 @@ class OFChannelHandler extends IdleStateAwareChannelHandler {
          * @param m The OFMessage that has just been received
          * @param m The OFMessage that has just been received
          * @param details A string giving more details about the exact nature
          * @param details A string giving more details about the exact nature
          * of the problem.
          * of the problem.
-         * @return
+         * @return display string
          */
          */
         // needs to be protected because enum members are actually subclasses
         // needs to be protected because enum members are actually subclasses
         protected String getSwitchStateMessage(OFChannelHandler h,
         protected String getSwitchStateMessage(OFChannelHandler h,
@@ -682,7 +682,7 @@ class OFChannelHandler extends IdleStateAwareChannelHandler {
 
 
         /**
         /**
          * Log an OpenFlow error message from a switch.
          * Log an OpenFlow error message from a switch.
-         * @param sw The switch that sent the error
+         * @param h The switch that sent the error
          * @param error The error message
          * @param error The error message
          */
          */
         @LogMessageDoc(level = "ERROR",
         @LogMessageDoc(level = "ERROR",
@@ -1185,7 +1185,7 @@ class OFChannelHandler extends IdleStateAwareChannelHandler {
     /**
     /**
      * Return a string describing this switch based on the already available
      * Return a string describing this switch based on the already available
      * information (DPID and/or remote socket).
      * information (DPID and/or remote socket).
-     * @return
+     * @return display string
      */
      */
     private String getSwitchInfoString() {
     private String getSwitchInfoString() {
         if (sw != null) {
         if (sw != null) {

@@ -69,7 +69,6 @@ class RoleManager implements RoleHandler {
      * Send NX role request message to the switch requesting the specified
      * Send NX role request message to the switch requesting the specified
      * role.
      * role.
      *
      *
-     * @param sw switch to send the role request message to
      * @param role role to request
      * @param role role to request
      */
      */
     private int sendNxRoleRequest(RoleState role) throws IOException {
     private int sendNxRoleRequest(RoleState role) throws IOException {
@@ -318,8 +317,7 @@ class RoleManager implements RoleHandler {
      * Extract the role from an OFVendor message if the message is a
      * Extract the role from an OFVendor message if the message is a
      * Nicira role reply. Otherwise return null.
      * Nicira role reply. Otherwise return null.
      *
      *
-     * @param h The channel handler receiving the message
-     * @param vendorMessage The vendor message to parse.
+     * @param experimenterMsg message
      * @return The role in the message if the message is a Nicira role
      * @return The role in the message if the message is a Nicira role
      * reply, null otherwise.
      * reply, null otherwise.
      * @throws SwitchStateException If the message is a Nicira role reply
      * @throws SwitchStateException If the message is a Nicira role reply
@@ -363,7 +361,7 @@ class RoleManager implements RoleHandler {
 
 
     /**
     /**
      * Extract the role information from an OF1.3 Role Reply Message.
      * Extract the role information from an OF1.3 Role Reply Message.
-     * @param h
+     *
      * @param rrmsg the role message
      * @param rrmsg the role message
      * @return RoleReplyInfo object
      * @return RoleReplyInfo object
      * @throws SwitchStateException if the role information could not be extracted.
      * @throws SwitchStateException if the role information could not be extracted.

@@ -22,4 +22,3 @@
     <suppress files=".java" checks="NewlineAtEndOfFile"/>
     <suppress files=".java" checks="NewlineAtEndOfFile"/>
 
 
 </suppressions>
 </suppressions>
-

@@ -67,7 +67,7 @@ public class ARP extends BasePacket {
     }
     }
 
 
     /**
     /**
-     * @param hardwareType
+     * @param hwType
      *            the hardwareType to set
      *            the hardwareType to set
      */
      */
     public ARP setHardwareType(final short hwType) {
     public ARP setHardwareType(final short hwType) {
@@ -83,7 +83,7 @@ public class ARP extends BasePacket {
     }
     }
 
 
     /**
     /**
-     * @param protocolType
+     * @param protoType
      *            the protocolType to set
      *            the protocolType to set
      */
      */
     public ARP setProtocolType(final short protoType) {
     public ARP setProtocolType(final short protoType) {
@@ -115,7 +115,7 @@ public class ARP extends BasePacket {
     }
     }
 
 
     /**
     /**
-     * @param protocolAddressLength
+     * @param protoAddressLength
      *            the protocolAddressLength to set
      *            the protocolAddressLength to set
      */
      */
     public ARP setProtocolAddressLength(final byte protoAddressLength) {
     public ARP setProtocolAddressLength(final byte protoAddressLength) {
@@ -131,7 +131,7 @@ public class ARP extends BasePacket {
     }
     }
 
 
     /**
     /**
-     * @param opCode
+     * @param op
      *            the opCode to set
      *            the opCode to set
      */
      */
     public ARP setOpCode(final short op) {
     public ARP setOpCode(final short op) {
@@ -147,7 +147,7 @@ public class ARP extends BasePacket {
     }
     }
 
 
     /**
     /**
-     * @param senderHardwareAddress
+     * @param senderHWAddress
      *            the senderHardwareAddress to set
      *            the senderHardwareAddress to set
      */
      */
     public ARP setSenderHardwareAddress(final byte[] senderHWAddress) {
     public ARP setSenderHardwareAddress(final byte[] senderHWAddress) {
@@ -163,7 +163,7 @@ public class ARP extends BasePacket {
     }
     }
 
 
     /**
     /**
-     * @param senderProtocolAddress
+     * @param senderProtoAddress
      *            the senderProtocolAddress to set
      *            the senderProtocolAddress to set
      */
      */
     public ARP setSenderProtocolAddress(final byte[] senderProtoAddress) {
     public ARP setSenderProtocolAddress(final byte[] senderProtoAddress) {
@@ -185,7 +185,7 @@ public class ARP extends BasePacket {
     }
     }
 
 
     /**
     /**
-     * @param targetHardwareAddress
+     * @param targetHWAddress
      *            the targetHardwareAddress to set
      *            the targetHardwareAddress to set
      */
      */
     public ARP setTargetHardwareAddress(final byte[] targetHWAddress) {
     public ARP setTargetHardwareAddress(final byte[] targetHWAddress) {
@@ -218,7 +218,7 @@ public class ARP extends BasePacket {
     }
     }
 
 
     /**
     /**
-     * @param targetProtocolAddress
+     * @param targetProtoAddress
      *            the targetProtocolAddress to set
      *            the targetProtocolAddress to set
      */
      */
     public ARP setTargetProtocolAddress(final byte[] targetProtoAddress) {
     public ARP setTargetProtocolAddress(final byte[] targetProtoAddress) {

@@ -294,7 +294,7 @@ public class DHCP extends BasePacket {
     /**
     /**
      * Gets a specific DHCP option parameter.
      * Gets a specific DHCP option parameter.
      *
      *
-     * @param opetionCode
+     * @param optionCode
      *            The option code to get
      *            The option code to get
      * @return The value of the option if it exists, null otherwise
      * @return The value of the option if it exists, null otherwise
      */
      */

@@ -96,7 +96,7 @@ public class Ethernet extends BasePacket {
     /**
     /**
      * Sets the destination MAC address.
      * Sets the destination MAC address.
      *
      *
-     * @param destinationMACAddress the destination MAC to set
+     * @param destMac the destination MAC to set
      * @return the Ethernet frame
      * @return the Ethernet frame
      */
      */
     public Ethernet setDestinationMACAddress(final byte[] destMac) {
     public Ethernet setDestinationMACAddress(final byte[] destMac) {
@@ -107,7 +107,7 @@ public class Ethernet extends BasePacket {
     /**
     /**
      * Sets the destination MAC address.
      * Sets the destination MAC address.
      *
      *
-     * @param destinationMACAddress the destination MAC to set
+     * @param destMac the destination MAC to set
      * @return the Ethernet frame
      * @return the Ethernet frame
      */
      */
     public Ethernet setDestinationMACAddress(final String destMac) {
     public Ethernet setDestinationMACAddress(final String destMac) {
@@ -136,7 +136,7 @@ public class Ethernet extends BasePacket {
     /**
     /**
      * Sets the source MAC address.
      * Sets the source MAC address.
      *
      *
-     * @param sourceMACAddress the source MAC to set
+     * @param sourceMac the source MAC to set
      * @return the Ethernet frame
      * @return the Ethernet frame
      */
      */
     public Ethernet setSourceMACAddress(final byte[] sourceMac) {
     public Ethernet setSourceMACAddress(final byte[] sourceMac) {
@@ -147,7 +147,7 @@ public class Ethernet extends BasePacket {
     /**
     /**
      * Sets the source MAC address.
      * Sets the source MAC address.
      *
      *
-     * @param sourceMACAddress the source MAC to set
+     * @param sourceMac the source MAC to set
      * @return the Ethernet frame
      * @return the Ethernet frame
      */
      */
     public Ethernet setSourceMACAddress(final String sourceMac) {
     public Ethernet setSourceMACAddress(final String sourceMac) {
@@ -167,7 +167,7 @@ public class Ethernet extends BasePacket {
     /**
     /**
      * Sets the priority code.
      * Sets the priority code.
      *
      *
-     * @param priorityCode the priorityCode to set
+     * @param priority the priorityCode to set
      * @return the Ethernet frame
      * @return the Ethernet frame
      */
      */
     public Ethernet setPriorityCode(final byte priority) {
     public Ethernet setPriorityCode(final byte priority) {
@@ -187,7 +187,7 @@ public class Ethernet extends BasePacket {
     /**
     /**
      * Sets the VLAN ID.
      * Sets the VLAN ID.
      *
      *
-     * @param vlanID the vlanID to set
+     * @param vlan the vlanID to set
      * @return the Ethernet frame
      * @return the Ethernet frame
      */
      */
     public Ethernet setVlanID(final short vlan) {
     public Ethernet setVlanID(final short vlan) {
@@ -207,7 +207,7 @@ public class Ethernet extends BasePacket {
     /**
     /**
      * Sets the Ethernet type.
      * Sets the Ethernet type.
      *
      *
-     * @param etherType the etherType to set
+     * @param ethType the etherType to set
      * @return the Ethernet frame
      * @return the Ethernet frame
      */
      */
     public Ethernet setEtherType(final short ethType) {
     public Ethernet setEtherType(final short ethType) {
@@ -242,7 +242,7 @@ public class Ethernet extends BasePacket {
     /**
     /**
      * Pad this packet to 60 bytes minimum, filling with zeros?
      * Pad this packet to 60 bytes minimum, filling with zeros?
      *
      *
-     * @param pad
+     * @param pd
      *            the pad to set
      *            the pad to set
      */
      */
     public Ethernet setPad(final boolean pd) {
     public Ethernet setPad(final boolean pd) {
@@ -535,7 +535,7 @@ public class Ethernet extends BasePacket {
         } else if (pkt instanceof LLC) {
         } else if (pkt instanceof LLC) {
             sb.append("\nllc packet");
             sb.append("\nllc packet");
         } else {
         } else {
-            sb.append("\nunknwon packet");
+            sb.append("\nunknown packet");
         }
         }
 
 
         return sb.toString();
         return sb.toString();

@@ -38,27 +38,27 @@ package org.onlab.packet;
 public interface IPacket {
 public interface IPacket {
     /**
     /**
      *
      *
-     * @return
+     * @return the payload
      */
      */
     public IPacket getPayload();
     public IPacket getPayload();
 
 
     /**
     /**
      *
      *
-     * @param packet
-     * @return
+     * @param packet new payload
+     * @return self
      */
      */
     public IPacket setPayload(IPacket packet);
     public IPacket setPayload(IPacket packet);
 
 
     /**
     /**
      *
      *
-     * @return
+     * @return parent packet
      */
      */
     public IPacket getParent();
     public IPacket getParent();
 
 
     /**
     /**
      *
      *
-     * @param packet
-     * @return
+     * @param packet new parent
+     * @return self
      */
      */
     public IPacket setParent(IPacket packet);
     public IPacket setParent(IPacket packet);
 
 
@@ -90,7 +90,7 @@ public interface IPacket {
     /**
     /**
      * Clone this packet and its payload packet but not its parent.
      * Clone this packet and its payload packet but not its parent.
      *
      *
-     * @return
+     * @return the clone
      */
      */
     public Object clone();
     public Object clone();
 }
 }

@@ -422,8 +422,8 @@ public class IPv4 extends BasePacket {
      * Accepts an IPv4 address of the form xxx.xxx.xxx.xxx, ie 192.168.0.1 and
      * Accepts an IPv4 address of the form xxx.xxx.xxx.xxx, ie 192.168.0.1 and
      * returns the corresponding 32 bit integer.
      * returns the corresponding 32 bit integer.
      *
      *
-     * @param ipAddress
-     * @return
+     * @param ipAddress ip address in string form
+     * @return int ip address value
      */
      */
     public static int toIPv4Address(final String ipAddress) {
     public static int toIPv4Address(final String ipAddress) {
         if (ipAddress == null) {
         if (ipAddress == null) {
@@ -447,8 +447,8 @@ public class IPv4 extends BasePacket {
      * Accepts an IPv4 address in a byte array and returns the corresponding
      * Accepts an IPv4 address in a byte array and returns the corresponding
      * 32-bit integer value.
      * 32-bit integer value.
      *
      *
-     * @param ipAddress
-     * @return
+     * @param ipAddress ip address in byte form
+     * @return int ip address value
      */
      */
     public static int toIPv4Address(final byte[] ipAddress) {
     public static int toIPv4Address(final byte[] ipAddress) {
         int ip = 0;
         int ip = 0;
@@ -463,8 +463,8 @@ public class IPv4 extends BasePacket {
      * Accepts an IPv4 address and returns of string of the form xxx.xxx.xxx.xxx,
      * Accepts an IPv4 address and returns of string of the form xxx.xxx.xxx.xxx,
      * e.g., 192.168.0.1.
      * e.g., 192.168.0.1.
      *
      *
-     * @param ipAddress
-     * @return
+     * @param ipAddress ip address in form
+     * @return string form of ip address
      */
      */
     public static String fromIPv4Address(final int ipAddress) {
     public static String fromIPv4Address(final int ipAddress) {
         final StringBuffer sb = new StringBuffer();
         final StringBuffer sb = new StringBuffer();
@@ -486,7 +486,7 @@ public class IPv4 extends BasePacket {
      *
      *
      * @param ipAddresses
      * @param ipAddresses
      *            collection
      *            collection
-     * @return
+     * @return ip addresses in comma-separated string form
      */
      */
     public static String fromIPv4AddressCollection(
     public static String fromIPv4AddressCollection(
             final Collection<Integer> ipAddresses) {
             final Collection<Integer> ipAddresses) {

@@ -62,7 +62,7 @@ public class LLDP extends BasePacket {
     }
     }
 
 
     /**
     /**
-     * @param chassisId
+     * @param chassis
      *            the chassisId to set
      *            the chassisId to set
      */
      */
     public LLDP setChassisId(final LLDPTLV chassis) {
     public LLDP setChassisId(final LLDPTLV chassis) {

@@ -228,7 +228,7 @@ public class ONLabLddp extends LLDP {
     /**
     /**
      * Sets switch DPID in LLDP packet.
      * Sets switch DPID in LLDP packet.
      *
      *
-     * @param sw the switch instance
+     * @param dp the switch instance
      */
      */
     public void setSwitch(long dp) {
     public void setSwitch(long dp) {
         final byte[] dpid = ByteBuffer.allocate(8).putLong(dp)
         final byte[] dpid = ByteBuffer.allocate(8).putLong(dp)
@@ -243,8 +243,7 @@ public class ONLabLddp extends LLDP {
      * @param port the port instance
      * @param port the port instance
      */
      */
     public void setPort(int port) {
     public void setPort(int port) {
-        int portNumber = port;
-        this.setPortTLV(portNumber);
+        this.setPortTLV(port);
     }
     }
 
 
     /**
     /**
@@ -260,7 +259,7 @@ public class ONLabLddp extends LLDP {
      * Checks if LLDP packet has correct size, LLDP multicast address, and
      * Checks if LLDP packet has correct size, LLDP multicast address, and
      * ethertype. Packet assumed to have Ethernet header.
      * ethertype. Packet assumed to have Ethernet header.
      *
      *
-     * @param packet
+     * @param packet packet data
      * @return true if packet is LLDP, false otherwise
      * @return true if packet is LLDP, false otherwise
      */
      */
     public static boolean isLLDP(final byte[] packet) {
     public static boolean isLLDP(final byte[] packet) {
@@ -304,8 +303,8 @@ public class ONLabLddp extends LLDP {
      * organizationally specific TLVs that use ON.Lab's OUI. Assumes packet is
      * organizationally specific TLVs that use ON.Lab's OUI. Assumes packet is
      * valid LLDP packet
      * valid LLDP packet
      *
      *
-     * @param packet
-     * @return
+     * @param packet packet data
+     * @return eth type or -1
      */
      */
     public static short isOVXLLDP(byte[] packet) {
     public static short isOVXLLDP(byte[] packet) {
         if (packet.length < OVX_LLDP_SIZE) {
         if (packet.length < OVX_LLDP_SIZE) {
@@ -340,7 +339,7 @@ public class ONLabLddp extends LLDP {
     /**
     /**
      * Extracts dpid and port from OVX-generated LLDP packet.
      * Extracts dpid and port from OVX-generated LLDP packet.
      *
      *
-     * @param packet
+     * @param packet packet data
      * @return Dpid and port
      * @return Dpid and port
      */
      */
     public static DPIDandPort parseLLDP(final byte[] packet) {
     public static DPIDandPort parseLLDP(final byte[] packet) {