Slight improvements in documentation.

[Mograsim.git] / net.mograsim.logic.ui / src / net / mograsim / logic / ui / model / components / GUIComponent.java

diff --git a/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/GUIComponent.java b/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/GUIComponent.java
index fd48e62..f961caf 100644 (file)
--- a/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/GUIComponent.java
+++ b/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/GUIComponent.java
@@ -140,12 +140,24 @@ public abstract class GUIComponent
 
        // high-level access
 
+       /**
+        * Sets the given high-level state to the given value. <br>
+        * TODO more documentation!
+        * 
+        * @author Daniel Kirschten
+        */
        @SuppressWarnings({ "static-method", "unused" }) // this method is intended to be overridden
        public void setHighLevelState(String stateID, Object newState)
        {
                throw new IllegalArgumentException("No high level state with ID " + stateID);
        }
 
+       /**
+        * Gets the current value of the given high-level state. <br>
+        * TODO more documentation!
+        * 
+        * @author Daniel Kirschten
+        */
        @SuppressWarnings("static-method") // this method is intended to be overridden
        public Object getHighLevelState(String stateID)
        {