Enable checkstyle Javadoc Comment Style rule
Turn on the Javadoc Comment Style rule and fix
any violations that come up. This is related to
requiring javadoc description comments to end
with a '.'
Change-Id: I19cf1b9f00d3040987e0b4c8b39461e2e0ad66b5
diff --git a/src/main/java/net/onrc/onos/core/linkdiscovery/ILinkDiscoveryService.java b/src/main/java/net/onrc/onos/core/linkdiscovery/ILinkDiscoveryService.java
index 14e78d8..c5543a2 100644
--- a/src/main/java/net/onrc/onos/core/linkdiscovery/ILinkDiscoveryService.java
+++ b/src/main/java/net/onrc/onos/core/linkdiscovery/ILinkDiscoveryService.java
@@ -31,7 +31,7 @@
public Map<Link, LinkInfo> getLinks();
/**
- * Returns link type of a given link
+ * Returns link type of a given link.
*
* @param info
* @return
@@ -45,7 +45,7 @@
public Map<Long, Set<Link>> getSwitchLinks();
/**
- * Adds a listener to listen for ILinkDiscoveryService messages
+ * Adds a listener to listen for ILinkDiscoveryService messages.
*
* @param listener The listener that wants the notifications
*/
@@ -57,17 +57,17 @@
public Set<NodePortTuple> getSuppressLLDPsInfo();
/**
- * Adds a switch port to suppress lldp set
+ * Adds a switch port to suppress lldp set.
*/
public void addToSuppressLLDPs(long sw, short port);
/**
- * Removes a switch port from suppress lldp set
+ * Removes a switch port from suppress lldp set.
*/
public void removeFromSuppressLLDPs(long sw, short port);
/**
- * Get the set of quarantined ports on a switch
+ * Get the set of quarantined ports on a switch.
*/
public Set<Short> getQuarantinedPorts(long sw);
diff --git a/src/main/java/net/onrc/onos/core/linkdiscovery/NodePortTuple.java b/src/main/java/net/onrc/onos/core/linkdiscovery/NodePortTuple.java
index 224ca3a..c586ecc 100644
--- a/src/main/java/net/onrc/onos/core/linkdiscovery/NodePortTuple.java
+++ b/src/main/java/net/onrc/onos/core/linkdiscovery/NodePortTuple.java
@@ -19,7 +19,7 @@
protected short portId; // switch port id
/**
- * Creates a NodePortTuple
+ * Creates a NodePortTuple.
*
* @param nodeId The DPID of the switch
* @param portId The port of the switch
@@ -91,7 +91,7 @@
/**
* API to return a String value formed wtih NodeID and PortID
* The portID is a 16-bit field, so mask it as an integer to get full
- * positive value
+ * positive value.
*
* @return
*/
diff --git a/src/main/java/net/onrc/onos/core/linkdiscovery/internal/EventHistoryTopologyCluster.java b/src/main/java/net/onrc/onos/core/linkdiscovery/internal/EventHistoryTopologyCluster.java
index e37252d..12ed97b 100644
--- a/src/main/java/net/onrc/onos/core/linkdiscovery/internal/EventHistoryTopologyCluster.java
+++ b/src/main/java/net/onrc/onos/core/linkdiscovery/internal/EventHistoryTopologyCluster.java
@@ -6,7 +6,7 @@
import org.codehaus.jackson.map.annotate.JsonSerialize;
/**
- * Topology Cluster merge/split event history related classes and members
+ * Topology Cluster merge/split event history related classes and members.
*
* @author subrata
*/
diff --git a/src/main/java/net/onrc/onos/core/linkdiscovery/internal/EventHistoryTopologyLink.java b/src/main/java/net/onrc/onos/core/linkdiscovery/internal/EventHistoryTopologyLink.java
index f172fdd..50c6c7e 100644
--- a/src/main/java/net/onrc/onos/core/linkdiscovery/internal/EventHistoryTopologyLink.java
+++ b/src/main/java/net/onrc/onos/core/linkdiscovery/internal/EventHistoryTopologyLink.java
@@ -6,7 +6,7 @@
import org.codehaus.jackson.map.annotate.JsonSerialize;
/**
- * Topology link up/down event history related classes and members
+ * Topology link up/down event history related classes and members.
*
* @author subrata
*/
diff --git a/src/main/java/net/onrc/onos/core/linkdiscovery/internal/EventHistoryTopologySwitch.java b/src/main/java/net/onrc/onos/core/linkdiscovery/internal/EventHistoryTopologySwitch.java
index 7d0503f..456f176 100644
--- a/src/main/java/net/onrc/onos/core/linkdiscovery/internal/EventHistoryTopologySwitch.java
+++ b/src/main/java/net/onrc/onos/core/linkdiscovery/internal/EventHistoryTopologySwitch.java
@@ -7,7 +7,7 @@
import org.codehaus.jackson.map.annotate.JsonSerialize;
/**
- * Topology Switch event history related classes and members
+ * Topology Switch event history related classes and members.
*
* @author subrata
*/
diff --git a/src/main/java/net/onrc/onos/core/linkdiscovery/internal/LinkDiscoveryManager.java b/src/main/java/net/onrc/onos/core/linkdiscovery/internal/LinkDiscoveryManager.java
index 4cb8bc7..9b913c1 100644
--- a/src/main/java/net/onrc/onos/core/linkdiscovery/internal/LinkDiscoveryManager.java
+++ b/src/main/java/net/onrc/onos/core/linkdiscovery/internal/LinkDiscoveryManager.java
@@ -101,14 +101,14 @@
* <p/>
* Invariants:
* -portLinks and switchLinks will not contain empty Sets outside of
- * critical sections
+ * critical sections.
* -portLinks contains LinkTuples where one of the src or dst
- * SwitchPortTuple matches the map key
+ * SwitchPortTuple matches the map key.
* -switchLinks contains LinkTuples where one of the src or dst
- * SwitchPortTuple's id matches the switch id
+ * SwitchPortTuple's id matches the switch id.
* -Each LinkTuple will be indexed into switchLinks for both
- * src.id and dst.id, and portLinks for each src and dst
- * -The updates queue is only added to from within a held write lock
+ * src.id and dst.id, and portLinks for each src and dst.
+ * -The updates queue is only added to from within a held write lock.
*/
@LogMessageCategory("Network Topology")
public class LinkDiscoveryManager
@@ -181,17 +181,17 @@
protected Map<Long, IOnosRemoteSwitch> remoteSwitches;
/**
- * Map from link to the most recent time it was verified functioning
+ * Map from link to the most recent time it was verified functioning.
*/
protected Map<Link, LinkInfo> links;
/**
- * Map from switch id to a set of all links with it as an endpoint
+ * Map from switch id to a set of all links with it as an endpoint.
*/
protected Map<Long, Set<Link>> switchLinks;
/**
- * Map from a id:port to the set of links containing it as an endpoint
+ * Map from a id:port to the set of links containing it as an endpoint.
*/
protected Map<NodePortTuple, Set<Link>> portLinks;
@@ -203,8 +203,10 @@
protected volatile boolean shuttingDown = false;
- /* topology aware components are called in the order they were added to the
- * the array */
+ /**
+ * Topology aware components are called in the order they were added to the
+ * the array.
+ */
protected ArrayList<ILinkDiscoveryListener> linkDiscoveryAware;
protected class LinkUpdate extends LDUpdate {
@@ -252,7 +254,7 @@
protected LinkedBlockingQueue<NodePortTuple> quarantineQueue;
protected LinkedBlockingQueue<NodePortTuple> maintenanceQueue;
/**
- * Quarantine task
+ * Quarantine task.
*/
protected SingletonTask bddpTask;
protected static final int BDDP_TASK_INTERVAL = 100; // 100 ms.
@@ -274,7 +276,7 @@
}
/**
- * Get the LLDP timeout value in seconds
+ * Get the LLDP timeout value in seconds.
*
* @return LLDP timeout value in seconds
*/
@@ -498,7 +500,7 @@
}
/**
- * Send LLDP on known ports
+ * Send LLDP on known ports.
*/
protected void discoverOnKnownLinkPorts() {
// Copy the port set.
@@ -520,7 +522,7 @@
}
/**
- * Learn remote switches when running as a distributed controller ONOS
+ * Learn remote switches when running as a distributed controller ONOS.
*/
protected IOFSwitch addRemoteSwitch(long sw, short port) {
IOnosRemoteSwitch remotesw = null;
@@ -697,7 +699,7 @@
}
/**
- * Send LLDPs to all switch-ports
+ * Send LLDPs to all switch-ports.
*/
protected void discoverOnAllPorts() {
if (log.isTraceEnabled()) {
@@ -1409,7 +1411,7 @@
}
/**
- * We send out LLDP messages when a switch is added to discover the topology
+ * We send out LLDP messages when a switch is added to discover the topology.
*
* @param sw The IOFSwitch that connected to the controller
*/
@@ -1631,7 +1633,7 @@
}
/**
- * Register a link discovery aware component
+ * Register a link discovery aware component.
*
* @param linkDiscoveryAwareComponent
*/
@@ -1641,7 +1643,7 @@
}
/**
- * Deregister a link discovery aware component
+ * Deregister a link discovery aware component.
*
* @param linkDiscoveryAwareComponent
*/
diff --git a/src/main/java/net/onrc/onos/core/linkdiscovery/web/LinkDiscoveryWebRoutable.java b/src/main/java/net/onrc/onos/core/linkdiscovery/web/LinkDiscoveryWebRoutable.java
index f78d43a..39ecbfa 100644
--- a/src/main/java/net/onrc/onos/core/linkdiscovery/web/LinkDiscoveryWebRoutable.java
+++ b/src/main/java/net/onrc/onos/core/linkdiscovery/web/LinkDiscoveryWebRoutable.java
@@ -18,7 +18,7 @@
}
/**
- * Set the base path for the Topology
+ * Set the base path for the Topology.
*/
@Override
public String basePath() {