Added comments in BasicGUIComponent
authorDaniel Kirschten <daniel.kirschten@gmx.de>
Wed, 15 May 2019 09:47:31 +0000 (11:47 +0200)
committerDaniel Kirschten <daniel.kirschten@gmx.de>
Wed, 15 May 2019 09:47:31 +0000 (11:47 +0200)
LogicUI/src/era/mi/components/gui/BasicGUIComponent.java

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