svn commit: r14535 - trunk/src/argouml-app/src/org/argouml/cognitive/Highlightable.java

Author: tfmorris
Date: 2008-04-30 13:28:09-0700
New Revision: 14535

Modified:
   trunk/src/argouml-app/src/org/argouml/cognitive/Highlightable.java

Log:
Add Javadoc and TODO

Modified: trunk/src/argouml-app/src/org/argouml/cognitive/Highlightable.java
Url: http://argouml.tigris.org/source/browse/argouml/trunk/src/argouml-app/src/org/argouml/cognitive/Highlightable.java?view=diff&rev=14535&p1=trunk/src/argouml-app/src/org/argouml/cognitive/Highlightable.java&p2=trunk/src/argouml-app/src/org/argouml/cognitive/Highlightable.java&r1=14534&r2=14535
==============================================================================
--- trunk/src/argouml-app/src/org/argouml/cognitive/Highlightable.java	(original)
+++ trunk/src/argouml-app/src/org/argouml/cognitive/Highlightable.java	2008-04-30 13:28:09-0700
@@ -24,11 +24,23 @@
 
 package org.argouml.cognitive;
 
+// TODO: This probably belongs with the Diagram subsystem
 /**
- * Interface to be implementable by figures which can be highlighted to
- * visually show where a problem identified by the Critic subsystem is located.
+ * Interface to be implementable by figures which can be highlighted to visually
+ * identify them.
+ * 
+ * @author Bob Tarling
  */
 public interface Highlightable {
-    void setHighlight(boolean b);
+    
+    /**
+     * Set the highlighted state.
+     * @param highlighted true to highlight the fig
+     */
+    void setHighlight(boolean highlighted);
+
+    /**
+     * @return the current highlight state
+     */
     boolean getHighlight();
-} /* end interface Highlightable */
+}
\ No newline at end of file