From e0659e668a28b49c7497f5612ff48fead65ef86b Mon Sep 17 00:00:00 2001
From: hneemann <helmut.neemann@arcor.de>
Date: Sat, 19 Mar 2016 09:33:21 +0100
Subject: [PATCH] added some comments

---
 .../de/neemann/digital/gui/draw/shapes/GenericShape.java   | 3 +++
 .../de/neemann/digital/gui/draw/shapes/Interactor.java     | 5 +++++
 .../de/neemann/digital/gui/draw/shapes/ProbeShape.java     | 1 -
 .../java/de/neemann/digital/gui/draw/shapes/Shape.java     | 2 ++
 .../de/neemann/digital/gui/draw/shapes/StateMonitor.java   | 7 -------
 5 files changed, 10 insertions(+), 8 deletions(-)
 delete mode 100644 src/main/java/de/neemann/digital/gui/draw/shapes/StateMonitor.java

diff --git a/src/main/java/de/neemann/digital/gui/draw/shapes/GenericShape.java b/src/main/java/de/neemann/digital/gui/draw/shapes/GenericShape.java
index a4a254ece..777c5e15d 100644
--- a/src/main/java/de/neemann/digital/gui/draw/shapes/GenericShape.java
+++ b/src/main/java/de/neemann/digital/gui/draw/shapes/GenericShape.java
@@ -8,6 +8,9 @@ import de.neemann.digital.gui.draw.parts.Pins;
 import de.neemann.digital.gui.draw.parts.State;
 
 /**
+ * Universal Shape. Used for most components.
+ * Shows a simple Box with inputs at the left and outputs at the right.
+ *
  * @author hneemann
  */
 public class GenericShape implements Shape {
diff --git a/src/main/java/de/neemann/digital/gui/draw/shapes/Interactor.java b/src/main/java/de/neemann/digital/gui/draw/shapes/Interactor.java
index 91667c088..2f65593a5 100644
--- a/src/main/java/de/neemann/digital/gui/draw/shapes/Interactor.java
+++ b/src/main/java/de/neemann/digital/gui/draw/shapes/Interactor.java
@@ -5,6 +5,11 @@ import de.neemann.digital.gui.draw.graphics.Vector;
 import de.neemann.digital.gui.draw.parts.State;
 
 /**
+ * The VisualParts Interactor instance is called if the part is clicked
+ * during execution. So the User can interakt with the part during execution.
+ * Used at the InputShape to let the user toggle the inputs state.
+ *
+ * @see InputShape
  * @author hneemann
  */
 public interface Interactor {
diff --git a/src/main/java/de/neemann/digital/gui/draw/shapes/ProbeShape.java b/src/main/java/de/neemann/digital/gui/draw/shapes/ProbeShape.java
index 0209e4244..563357c51 100644
--- a/src/main/java/de/neemann/digital/gui/draw/shapes/ProbeShape.java
+++ b/src/main/java/de/neemann/digital/gui/draw/shapes/ProbeShape.java
@@ -15,7 +15,6 @@ import de.neemann.digital.gui.draw.parts.State;
  */
 public class ProbeShape implements Shape {
 
-
     private final String label;
 
     public ProbeShape(String label) {
diff --git a/src/main/java/de/neemann/digital/gui/draw/shapes/Shape.java b/src/main/java/de/neemann/digital/gui/draw/shapes/Shape.java
index c49c525c1..ee03adb47 100644
--- a/src/main/java/de/neemann/digital/gui/draw/shapes/Shape.java
+++ b/src/main/java/de/neemann/digital/gui/draw/shapes/Shape.java
@@ -12,6 +12,8 @@ public interface Shape extends Drawable {
 
     /**
      * Puts the pins name and the pins x-y-position together!
+     * This information is used to calculate the models connections
+     * from the wiring in the circuit.
      *
      * @return the pins
      */
diff --git a/src/main/java/de/neemann/digital/gui/draw/shapes/StateMonitor.java b/src/main/java/de/neemann/digital/gui/draw/shapes/StateMonitor.java
deleted file mode 100644
index e80e6175c..000000000
--- a/src/main/java/de/neemann/digital/gui/draw/shapes/StateMonitor.java
+++ /dev/null
@@ -1,7 +0,0 @@
-package de.neemann.digital.gui.draw.shapes;
-
-/**
- * @author hneemann
- */
-public interface StateMonitor {
-}