Fixing Javadoc errors

Change-Id: I72b9d49e052316cbbbef343d367ffffe13cd4e56

@@ -98,6 +98,7 @@ public class AclWebResource extends AbstractWebResource {
      *
      *
      * @param stream JSON data describing the rule
      * @param stream JSON data describing the rule
      * @return 200 OK
      * @return 200 OK
+     * @throws URISyntaxException uri syntax exception
      */
      */
     @POST
     @POST
     @Consumes(MediaType.APPLICATION_JSON)
     @Consumes(MediaType.APPLICATION_JSON)

@@ -64,6 +64,7 @@ public interface DhcpStore {
      * Releases the IP assigned to a Mac ID into the free pool.
      * Releases the IP assigned to a Mac ID into the free pool.
      *
      *
      * @param hostId the host ID for which the mapping needs to be changed
      * @param hostId the host ID for which the mapping needs to be changed
+     * @return released ip
      */
      */
     Ip4Address releaseIP(HostId hostId);
     Ip4Address releaseIP(HostId hostId);
 
 

@@ -85,6 +85,8 @@ public class FlowAnalyzer {
      * the network. The possible states are: Cleared (implying that the entry leads to
      * the network. The possible states are: Cleared (implying that the entry leads to
      * a host), Cycle (implying that it is part of cycle), and Black Hole (implying
      * a host), Cycle (implying that it is part of cycle), and Black Hole (implying
      * that the entry does not lead to a single host).
      * that the entry does not lead to a single host).
+     *
+     * @return result string
      */
      */
     public String analyze() {
     public String analyze() {
         graph = topologyService.getGraph(topologyService.currentTopology());
         graph = topologyService.getGraph(topologyService.currentTopology());

@@ -67,6 +67,8 @@ public class DeviceConfiguration implements DeviceProperties {
     /**
     /**
      * Constructor. Reads all the configuration for all devices of type
      * Constructor. Reads all the configuration for all devices of type
      * Segment Router and organizes into various maps for easier access.
      * Segment Router and organizes into various maps for easier access.
+     *
+     * @param cfgService config service
      */
      */
     public DeviceConfiguration(NetworkConfigRegistry cfgService) {
     public DeviceConfiguration(NetworkConfigRegistry cfgService) {
         // Read config from device subject, excluding gatewayIps and subnets.
         // Read config from device subject, excluding gatewayIps and subnets.

@@ -34,6 +34,7 @@ public class ControllerInfo {
      *
      *
      * @param ip   the ip address
      * @param ip   the ip address
      * @param port the tcp port
      * @param port the tcp port
+     * @param type the connection type
      */
      */
     public ControllerInfo(IpAddress ip, int port, String type) {
     public ControllerInfo(IpAddress ip, int port, String type) {
         this.ip = ip;
         this.ip = ip;

@@ -54,6 +54,8 @@ public interface TypedStoredFlowEntry extends StoredFlowEntry {
 
 
     /**
     /**
      * Gets the flow live type for this entry.
      * Gets the flow live type for this entry.
+     *
+     * @return flow live type
      */
      */
     FlowLiveType flowLiveType();
     FlowLiveType flowLiveType();
 
 

@@ -55,9 +55,10 @@ public interface HostProviderService extends ProviderService<HostProvider> {
     void hostVanished(HostId hostId);
     void hostVanished(HostId hostId);
 
 
     /**
     /**
-     * Notifies the core when a host is no longer detected on a network.
+     * Notifies the core when an IP is no longer associated with a host.
      *
      *
-     * @param hostId id of the host that vanished
+     * @param hostId id of the host
+     * @param ipAddress ip address of host that vanished
      */
      */
     void removeIpFromHost(HostId hostId, IpAddress ipAddress);
     void removeIpFromHost(HostId hostId, IpAddress ipAddress);
 
 

@@ -94,6 +94,7 @@ public interface FlowStatisticService {
      * @param pNumber the port number of the Device to query
      * @param pNumber the port number of the Device to query
      * @param liveType the FlowLiveType  to filter, null means no filtering .
      * @param liveType the FlowLiveType  to filter, null means no filtering .
      * @param instType the InstructionType to filter, null means no filtering.
      * @param instType the InstructionType to filter, null means no filtering.
+     * @param topn topn //FIXME what?
      * @return list of flow entry load
      * @return list of flow entry load
      */
      */
     List<TypedFlowEntryWithLoad> loadTopnByType(Device device, PortNumber pNumber,
     List<TypedFlowEntryWithLoad> loadTopnByType(Device device, PortNumber pNumber,

@@ -94,6 +94,8 @@ public class SummaryFlowEntryWithLoad {
 
 
     /**
     /**
      * Returns connect point.
      * Returns connect point.
+     *
+     * @return connect point
      */
      */
     public ConnectPoint connectPoint() {
     public ConnectPoint connectPoint() {
         return cp;
         return cp;
@@ -101,6 +103,8 @@ public class SummaryFlowEntryWithLoad {
 
 
     /**
     /**
      * Returns total load of connect point.
      * Returns total load of connect point.
+     *
+     * @return total load
      */
      */
     public Load totalLoad() {
     public Load totalLoad() {
         return totalLoad;
         return totalLoad;
@@ -108,6 +112,8 @@ public class SummaryFlowEntryWithLoad {
 
 
     /**
     /**
      * Returns immediate load of connect point.
      * Returns immediate load of connect point.
+     *
+     * @return immediate load
      */
      */
     public Load immediateLoad() {
     public Load immediateLoad() {
         return immediateLoad;
         return immediateLoad;
@@ -115,6 +121,8 @@ public class SummaryFlowEntryWithLoad {
 
 
     /**
     /**
      * Returns short load of connect point.
      * Returns short load of connect point.
+     *
+     * @return short load
      */
      */
     public Load shortLoad() {
     public Load shortLoad() {
         return shortLoad;
         return shortLoad;
@@ -122,6 +130,8 @@ public class SummaryFlowEntryWithLoad {
 
 
     /**
     /**
      * Returns mid load of connect point.
      * Returns mid load of connect point.
+     *
+     * @return mid load
      */
      */
     public Load midLoad() {
     public Load midLoad() {
         return midLoad;
         return midLoad;
@@ -129,6 +139,8 @@ public class SummaryFlowEntryWithLoad {
 
 
     /**
     /**
      * Returns long load of connect point.
      * Returns long load of connect point.
+     *
+     * @return long load
      */
      */
     public Load longLoad() {
     public Load longLoad() {
         return longLoad;
         return longLoad;
@@ -136,6 +148,8 @@ public class SummaryFlowEntryWithLoad {
 
 
     /**
     /**
      * Returns unknown load of connect point.
      * Returns unknown load of connect point.
+     *
+     * @return unknown load
      */
      */
     public Load unknownLoad() {
     public Load unknownLoad() {
         return unknownLoad;
         return unknownLoad;

@@ -36,19 +36,37 @@ public class TypedFlowEntryWithLoad {
     private static final int MID_POLL_INTERVAL = 10;
     private static final int MID_POLL_INTERVAL = 10;
     private static final int LONG_POLL_INTERVAL = 15;
     private static final int LONG_POLL_INTERVAL = 15;
 
 
-
+    /**
+     * Creates a new typed flow entry with load.
+     *
+     * @param cp connect point
+     * @param tfe typed flow entry
+     * @param load load
+     */
     public TypedFlowEntryWithLoad(ConnectPoint cp, TypedStoredFlowEntry tfe, Load load) {
     public TypedFlowEntryWithLoad(ConnectPoint cp, TypedStoredFlowEntry tfe, Load load) {
         this.cp = cp;
         this.cp = cp;
         this.tfe = tfe;
         this.tfe = tfe;
         this.load = load;
         this.load = load;
     }
     }
 
 
+    /**
+     * Creates a new typed flow entry with load.
+     *
+     * @param cp connect point
+     * @param tfe typed flow entry
+     */
     public TypedFlowEntryWithLoad(ConnectPoint cp, TypedStoredFlowEntry tfe) {
     public TypedFlowEntryWithLoad(ConnectPoint cp, TypedStoredFlowEntry tfe) {
         this.cp = cp;
         this.cp = cp;
         this.tfe = tfe;
         this.tfe = tfe;
         this.load = new DefaultLoad(tfe.bytes(), 0, typedPollInterval(tfe));
         this.load = new DefaultLoad(tfe.bytes(), 0, typedPollInterval(tfe));
     }
     }
 
 
+    /**
+     * Creates a new typed flow entry with load.
+     *
+     * @param cp connect point
+     * @param fe flow entry
+     */
     public TypedFlowEntryWithLoad(ConnectPoint cp, FlowEntry fe) {
     public TypedFlowEntryWithLoad(ConnectPoint cp, FlowEntry fe) {
         this.cp = cp;
         this.cp = cp;
         this.tfe = newTypedStoredFlowEntry(fe);
         this.tfe = newTypedStoredFlowEntry(fe);
@@ -70,6 +88,8 @@ public class TypedFlowEntryWithLoad {
 
 
     /**
     /**
      * Returns short polling interval.
      * Returns short polling interval.
+     *
+     * @return short poll interval
      */
      */
     public static int shortPollInterval() {
     public static int shortPollInterval() {
         return CAL_AND_POLL_INTERVAL;
         return CAL_AND_POLL_INTERVAL;
@@ -77,6 +97,8 @@ public class TypedFlowEntryWithLoad {
 
 
     /**
     /**
      * Returns mid polling interval.
      * Returns mid polling interval.
+     *
+     * @return mid poll interval
      */
      */
     public static int midPollInterval() {
     public static int midPollInterval() {
         return MID_POLL_INTERVAL;
         return MID_POLL_INTERVAL;
@@ -84,6 +106,8 @@ public class TypedFlowEntryWithLoad {
 
 
     /**
     /**
      * Returns long polling interval.
      * Returns long polling interval.
+     *
+     * @return long poll interval
      */
      */
     public static int longPollInterval() {
     public static int longPollInterval() {
         return LONG_POLL_INTERVAL;
         return LONG_POLL_INTERVAL;
@@ -91,6 +115,8 @@ public class TypedFlowEntryWithLoad {
 
 
     /**
     /**
      * Returns average polling interval.
      * Returns average polling interval.
+     *
+     * @return average poll interval
      */
      */
     public static int avgPollInterval() {
     public static int avgPollInterval() {
         return (CAL_AND_POLL_INTERVAL + MID_POLL_INTERVAL + LONG_POLL_INTERVAL) / 3;
         return (CAL_AND_POLL_INTERVAL + MID_POLL_INTERVAL + LONG_POLL_INTERVAL) / 3;
@@ -100,6 +126,7 @@ public class TypedFlowEntryWithLoad {
      * Returns current typed flow entry's polling interval.
      * Returns current typed flow entry's polling interval.
      *
      *
      * @param tfe typed flow entry
      * @param tfe typed flow entry
+     * @return typed poll interval
      */
      */
     public static long typedPollInterval(TypedStoredFlowEntry tfe) {
     public static long typedPollInterval(TypedStoredFlowEntry tfe) {
         checkNotNull(tfe, "TypedStoredFlowEntry cannot be null");
         checkNotNull(tfe, "TypedStoredFlowEntry cannot be null");
@@ -120,6 +147,7 @@ public class TypedFlowEntryWithLoad {
      * Creates a new typed flow entry with the given flow entry fe.
      * Creates a new typed flow entry with the given flow entry fe.
      *
      *
      * @param fe flow entry
      * @param fe flow entry
+     * @return new typed flow entry
      */
      */
     public static TypedStoredFlowEntry newTypedStoredFlowEntry(FlowEntry fe) {
     public static TypedStoredFlowEntry newTypedStoredFlowEntry(FlowEntry fe) {
         if (fe == null) {
         if (fe == null) {

@@ -63,6 +63,7 @@ public interface AsyncAtomicCounter {
     /**
     /**
      * Atomically sets the given value to the current value.
      * Atomically sets the given value to the current value.
      *
      *
+     * @param value new value
      * @return future void
      * @return future void
      */
      */
     CompletableFuture<Void> set(long value);
     CompletableFuture<Void> set(long value);

@@ -158,8 +158,8 @@ public final class OpticalPortOperator implements ConfigOperator {
     /**
     /**
      * Returns a description built from an existing port and reported status.
      * Returns a description built from an existing port and reported status.
      *
      *
-     * @param port
-     * @param isEnabled
+     * @param port port
+     * @param isEnabled true if enabled
      * @return a PortDescription based on the port
      * @return a PortDescription based on the port
      */
      */
     static PortDescription descriptionOf(Port port, boolean isEnabled) {
     static PortDescription descriptionOf(Port port, boolean isEnabled) {

@@ -17,6 +17,7 @@ public interface VirtualNetworkProvider extends Provider {
      * @param networkId virtual network identifier
      * @param networkId virtual network identifier
      * @param src       source connection point
      * @param src       source connection point
      * @param dst       destination connection point
      * @param dst       destination connection point
+     * @return new tunnel's id
      */
      */
     TunnelId createTunnel(NetworkId networkId, ConnectPoint src, ConnectPoint dst);
     TunnelId createTunnel(NetworkId networkId, ConnectPoint src, ConnectPoint dst);
 
 

@@ -88,13 +88,14 @@ public interface OvsdbClientService extends OvsdbRPC {
     /**
     /**
      * Gets controllers of the node.
      * Gets controllers of the node.
      *
      *
+     * @param openflowDeviceId target device id
      * @return set of controllers; empty if no controller is find
      * @return set of controllers; empty if no controller is find
      */
      */
     Set<ControllerInfo> getControllers(DeviceId openflowDeviceId);
     Set<ControllerInfo> getControllers(DeviceId openflowDeviceId);
 
 
     /**
     /**
      * Sets the Controllers for the specified bridge.
      * Sets the Controllers for the specified bridge.
-     * <p/>
+     * <p>
      * This method will replace the existing controller list with the new controller
      * This method will replace the existing controller list with the new controller
      * list.
      * list.
      *
      *
@@ -105,7 +106,7 @@ public interface OvsdbClientService extends OvsdbRPC {
 
 
     /**
     /**
      * Sets the Controllers for the specified device.
      * Sets the Controllers for the specified device.
-     * <p/>
+     * <p>
      * This method will replace the existing controller list with the new controller
      * This method will replace the existing controller list with the new controller
      * list.
      * list.
      *
      *

@@ -56,6 +56,7 @@ public final class Row {
      *
      *
      * @param tableName table name
      * @param tableName table name
      * @param columns   Map of Column entity
      * @param columns   Map of Column entity
+     * @param uuid UUID of the row
      */
      */
     public Row(String tableName, UUID uuid, Map<String, Column> columns) {
     public Row(String tableName, UUID uuid, Map<String, Column> columns) {
         checkNotNull(tableName, "table name cannot be null");
         checkNotNull(tableName, "table name cannot be null");

@@ -492,6 +492,7 @@ public class NewAdaptiveFlowStatsCollector {
     /**
     /**
      * returns flowMissingXid that indicates the execution of flowMissing process or not(NO_FLOW_MISSING_XID(-1)).
      * returns flowMissingXid that indicates the execution of flowMissing process or not(NO_FLOW_MISSING_XID(-1)).
      *
      *
+     * @return xid of missing flow
      */
      */
     public long getFlowMissingXid() {
     public long getFlowMissingXid() {
         return flowMissingXid;
         return flowMissingXid;