Slight improvements in documentation.

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
 
 
        // 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);
        }
 
        @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)
        {
        @SuppressWarnings("static-method") // this method is intended to be overridden
        public Object getHighLevelState(String stateID)
        {

diff --git a/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/wires/GUIWire.java b/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/wires/GUIWire.java
index 99adc4c..33be875 100644 (file)
--- a/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/wires/GUIWire.java
+++ b/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/wires/GUIWire.java
@@ -312,6 +312,8 @@ public class GUIWire
 
        /**
         * Returns whether this {@link GUIWire} has a logic model binding or not.
 
        /**
         * Returns whether this {@link GUIWire} has a logic model binding or not.

+        * 
+        * @author Daniel Kirschten

         */
        public boolean hasLogicModelBinding()
        {
         */
        public boolean hasLogicModelBinding()
        {


@@ -321,6 +323,8 @@ public class GUIWire
        /**
         * If this {@link GUIWire} has a logic model binding, delegates to {@link Wire#forceValues(BitVector)} for the {@link Wire}
         * corresponding to this {@link GUIWire}.
        /**
         * If this {@link GUIWire} has a logic model binding, delegates to {@link Wire#forceValues(BitVector)} for the {@link Wire}
         * corresponding to this {@link GUIWire}.

+        * 
+        * @author Daniel Kirschten

         */
        public void forceWireValues(BitVector values)
        {
         */
        public void forceWireValues(BitVector values)
        {


@@ -330,6 +334,8 @@ public class GUIWire
        /**
         * If this {@link GUIWire} has a logic model binding, delegates to {@link ReadEnd#getValues()} for the {@link ReadEnd} corresponding to
         * this {@link GUIWire}.
        /**
         * If this {@link GUIWire} has a logic model binding, delegates to {@link ReadEnd#getValues()} for the {@link ReadEnd} corresponding to
         * this {@link GUIWire}.

+        * 
+        * @author Daniel Kirschten

         */
        public BitVector getWireValues()
        {
         */
        public BitVector getWireValues()
        {