Added comments in BasicGUIComponent

[Mograsim.git] / LogicUI / src / era / mi / components / gui / BasicGUIComponent.java

diff --git a/LogicUI/src/era/mi/components/gui/BasicGUIComponent.java b/LogicUI/src/era/mi/components/gui/BasicGUIComponent.java
index 92ec777..f7e7d37 100644 (file)
--- a/LogicUI/src/era/mi/components/gui/BasicGUIComponent.java
+++ b/LogicUI/src/era/mi/components/gui/BasicGUIComponent.java
@@ -6,9 +6,23 @@ import net.haspamelodica.swt.helper.swtobjectwrappers.Point;
 
 public interface BasicGUIComponent
 {
+       /**
+        * Render this component to the given gc, at coordinates (0, 0).
+        */
        public void render(GeneralGC gc);
 
+       //TODO this code will be replaced by code in BasicComponent.
+       /**
+        * Returns how many wire arrays are connected to this component.
+        * (Connections are static - they can't be removed and no new ones can be added)
+        */
        public int getConnectedWireArraysCount();
+       /**
+        * Returns the n-th wire array connected to this component.
+        */
        public WireArray getConnectedWireArray(int connectionIndex);
+       /**
+        * Returns relative coordinates where the n-th wire array is connected to this component.
+        */
        public Point getWireArrayConnectionPoint(int connectionIndex);
 }
\ No newline at end of file