From 553d67a03d7d1688a8467d40ea0c8cff3cbbc1fb Mon Sep 17 00:00:00 2001
From: Daniel Kirschten <daniel.kirschten@gmx.de>
Date: Wed, 26 Jun 2019 12:16:54 +0200
Subject: [PATCH] Commented Pin

---
 .../mograsim/logic/ui/model/wires/Pin.java    | 59 +++++++++++++++++++
 1 file changed, 59 insertions(+)

diff --git a/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/wires/Pin.java b/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/wires/Pin.java
index aec2df08..287a6237 100644
--- a/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/wires/Pin.java
+++ b/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/wires/Pin.java
@@ -7,18 +7,48 @@ import java.util.function.Consumer;
 import net.haspamelodica.swt.helper.swtobjectwrappers.Point;
 import net.mograsim.logic.ui.model.components.GUIComponent;
 
+/**
+ * A connection interface between a GUIComponent and the rest of a ViewModel. Pins usually are created by {@link GUIComponent}s themselves.
+ * <br>
+ * A pin has a name identifying it. Pin names are unique for a {@link GUIComponent}: Every pin of a {@link GUIComponent} has a different
+ * name, but different {@link GUIComponent}s can have pins with the same name.
+ * 
+ * @author Daniel Kirschten
+ */
 public class Pin
 {
+	/**
+	 * The {@link GUIComponent} this pin belongs to
+	 */
 	public final GUIComponent component;
+	/**
+	 * The name identifying this pin. Is unique for a {@link GUIComponent}.
+	 */
 	public final String name;
+	/**
+	 * The logical width of this pin. Denotes how many bits this pin consists of.
+	 */
 	public final int logicWidth;
 
+	/**
+	 * The X position of this pin, relative to its component's location.
+	 */
 	protected double relX;
+	/**
+	 * The Y position of this pin, relative to its component's location.
+	 */
 	protected double relY;
 
 	private final List<Consumer<? super Pin>> pinMovedListeners;
 	private final List<Runnable> redrawListeners;
 
+	// creation and destruction
+
+	/**
+	 * Creates a new pin. Usually it is not needed to call this constructor manually, as {@link GUIComponent}s create their pins themselves.
+	 * 
+	 * @author Daniel Kirschten
+	 */
 	public Pin(GUIComponent component, String name, int logicWidth, double relX, double relY)
 	{
 		this.component = component;
@@ -33,26 +63,53 @@ public class Pin
 		component.addComponentMovedListener(c -> callPinMovedListeners());
 	}
 
+	// "graphical" operations
+
+	/**
+	 * Returns the X position of this pin relative to the position of its component.
+	 * 
+	 * @author Daniel Kirschten
+	 */
 	public double getRelX()
 	{
 		return relX;
 	}
 
+	/**
+	 * Returns the Y position of this pin relative to the position of its component.
+	 * 
+	 * @author Daniel Kirschten
+	 */
 	public double getRelY()
 	{
 		return relY;
 	}
 
+	/**
+	 * Returns the position of this pin relative to the position of its component.
+	 * 
+	 * @author Daniel Kirschten
+	 */
 	public Point getRelPos()
 	{
 		return new Point(relX, relY);
 	}
 
+	/**
+	 * Returns the absolute position of this pin.
+	 * 
+	 * @author Daniel Kirschten
+	 */
 	public Point getPos()
 	{
 		return new Point(relX + component.getPosX(), relY + component.getPosY());
 	}
 
+	/**
+	 * Sets the position of this pin relative to the position of its component.
+	 * 
+	 * @author Daniel Kirschten
+	 */
 	protected void setRelPos(double relX, double relY)
 	{
 		this.relX = relX;
@@ -61,6 +118,8 @@ public class Pin
 		callRedrawListeners();
 	}
 
+	// listeners
+
 	// @formatter:off
 	public void addPinMovedListener   (Consumer<? super Pin> listener){pinMovedListeners.add   (listener);}
 	public void addRedrawListener     (Runnable              listener){redrawListeners  .add   (listener);}
-- 
2.17.1