X-Git-Url: https://mograsim.net/gitweb/?a=blobdiff_plain;f=net.mograsim.logic.ui%2Fsrc%2Fnet%2Fmograsim%2Flogic%2Fui%2Fmodel%2Fcomponents%2FGUIComponent.java;fp=net.mograsim.logic.ui%2Fsrc%2Fnet%2Fmograsim%2Flogic%2Fui%2Fmodel%2Fcomponents%2FGUIComponent.java;h=a80c15c42ed216c89152399c30ea0e4cbffd9368;hb=574918bb58faa3c617911ed4f629f90066668364;hp=f961cafc16269553f5a76c032c7f944c229b0e43;hpb=bec6c3a711448475c7b8e43dd031efe7b89aba24;p=Mograsim.git

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 f961cafc..a80c15c4 100644
--- 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
@@ -142,7 +142,13 @@ public abstract class GUIComponent
 
 	/**
 	 * Sets the given high-level state to the given value. <br>
-	 * TODO more documentation!
+	 * A high level state ID consists of parts separated by dots ('.').<br>
+	 * The last part (the part after the last dot) is called "atomic high level state ID". The parts before that part are called
+	 * "subcomponent ID"s.<br>
+	 * If there is no dot in a high level state ID, the whole high level state ID is called atomic.<br>
+	 * Note that subcomponent IDs don't have to correspond to actual subcomponents. For example, a RAM component may supply subcomponent IDs
+	 * "c0000", "c0001" ... "cFFFF" without actually having a subcomponent for each cell. It also is allowed for an atomic high level state
+	 * ID to be delegated to a subcomponent.
 	 * 
 	 * @author Daniel Kirschten
 	 */
@@ -154,7 +160,7 @@ public abstract class GUIComponent
 
 	/**
 	 * Gets the current value of the given high-level state. <br>
-	 * TODO more documentation!
+	 * See {@link #setHighLevelState(String, Object)} for an explanation of high-level state IDs.
 	 * 
 	 * @author Daniel Kirschten
 	 */