Cleaning up Javadocs in core-ui classes.
Promoted Glyphs inner class to GlyphConstants.
Change-Id: Ib12a4556a75d98edb3544b9ae45605fab554fdcf
diff --git a/core/api/src/main/java/org/onosproject/ui/UiTopoOverlay.java b/core/api/src/main/java/org/onosproject/ui/UiTopoOverlay.java
index b598bdd..0d37685 100644
--- a/core/api/src/main/java/org/onosproject/ui/UiTopoOverlay.java
+++ b/core/api/src/main/java/org/onosproject/ui/UiTopoOverlay.java
@@ -27,6 +27,10 @@
/**
* Represents user interface topology view overlay.
+ * <p>
+ * This base class does little more than provide a logger and an identifier.
+ * Subclasses will probably want to override some or all of the base methods
+ * to do useful things during the life-cycle of the overlay.
*/
public class UiTopoOverlay {
@@ -40,7 +44,8 @@
private boolean isActive = false;
/**
- * Creates a new user interface topology view overlay descriptor.
+ * Creates a new user interface topology view overlay descriptor, with
+ * the given identifier.
*
* @param id overlay identifier
*/
@@ -139,7 +144,7 @@
* @param event the link event
* @return map of additional key/value pairs to be added to the JSON event
* @deprecated this is a temporary addition for Goldeneye (1.6) release,
- * and expected to be replaced in the Hummingbird (1.7) release
+ * and expected to be replaced in the Ibis (1.8) release
*/
@Deprecated
public Map<String, String> additionalLinkData(LinkEvent event) {