From: Daniel Kirschten <daniel.kirschten@gmx.de>
Date: Wed, 15 May 2019 09:47:31 +0000 (+0200)
Subject: Added comments in BasicGUIComponent
X-Git-Url: https://mograsim.net/gitweb/?a=commitdiff_plain;h=5eac6cf906bb62b1bcded92c97dfedde3c73ed82;p=Mograsim.git

Added comments in BasicGUIComponent
---

diff --git a/LogicUI/src/era/mi/components/gui/BasicGUIComponent.java b/LogicUI/src/era/mi/components/gui/BasicGUIComponent.java
index d11bc71e..8d263842 100644
--- 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