Fix/update Javadoc comments for the topology event classes:
HostEvent, LinkEvent, MastershipEvent, PortEvent, SwitchEvent
No functional changes.
Change-Id: I31cab2f01b79b09f84726e975b72f1ccab17ddbc
diff --git a/src/main/java/net/onrc/onos/core/topology/MastershipEvent.java b/src/main/java/net/onrc/onos/core/topology/MastershipEvent.java
index 1d54a52..45578db 100644
--- a/src/main/java/net/onrc/onos/core/topology/MastershipEvent.java
+++ b/src/main/java/net/onrc/onos/core/topology/MastershipEvent.java
@@ -21,7 +21,6 @@
*/
@JsonSerialize(using = MastershipEventSerializer.class)
public class MastershipEvent extends TopologyElement<MastershipEvent> {
-
private final Dpid dpid;
private final OnosInstanceId onosInstanceId;
private final Role role;
@@ -37,11 +36,12 @@
}
/**
- * Creates the Switch Mastership object.
+ * Constructor for given switch DPID, ONOS Instance ID, and ONOS instance
+ * role for the switch.
*
- * @param dpid the Switch DPID
+ * @param dpid the switch DPID
* @param onosInstanceId the ONOS Instance ID
- * @param role the ONOS instance role for the switch.
+ * @param role the ONOS instance role for the switch
*/
public MastershipEvent(Dpid dpid, OnosInstanceId onosInstanceId,
Role role) {
@@ -51,9 +51,11 @@
}
/**
- * Creates an unfrozen copy of given Object.
+ * Copy constructor.
+ * <p>
+ * Creates an unfrozen copy of the given Switch MastershipEvent object.
*
- * @param original to make copy of.
+ * @param original the object to make copy of
*/
public MastershipEvent(MastershipEvent original) {
super(original);
@@ -65,7 +67,7 @@
/**
* Gets the Switch DPID.
*
- * @return the Switch DPID.
+ * @return the Switch DPID
*/
public Dpid getDpid() {
return dpid;
@@ -74,7 +76,7 @@
/**
* Gets the ONOS Instance ID.
*
- * @return the ONOS Instance ID.
+ * @return the ONOS Instance ID
*/
public OnosInstanceId getOnosInstanceId() {
return onosInstanceId;
@@ -83,7 +85,7 @@
/**
* Gets the ONOS Controller Role for the Switch.
*
- * @return the ONOS Controller Role for the Switch.
+ * @return the ONOS Controller Role for the Switch
*/
public Role getRole() {
return role;
@@ -112,8 +114,8 @@
* MastershipEvent objects are equal if they have same DPID and same
* ONOS Instance ID.
*
- * @param o another object to compare to this.
- * @return true if equal, false otherwise.
+ * @param o another object to compare to this
+ * @return true if equal, false otherwise
*/
@Override
public boolean equals(Object o) {