From d606093884c2e292955dff6cc741844c1df5bcc9 Mon Sep 17 00:00:00 2001
From: hneemann <helmut.neemann@arcor.de>
Date: Wed, 31 Jan 2018 08:47:50 +0100
Subject: [PATCH] Added some comments

---
 src/main/java/de/neemann/digital/core/ObservableValue.java  | 6 ++++++
 src/main/java/de/neemann/digital/core/wiring/Delay.java     | 4 +++-
 .../de/neemann/digital/core/wiring/bus/CommonBusValue.java  | 3 ++-
 .../java/de/neemann/digital/integration/FileScanner.java    | 2 +-
 4 files changed, 12 insertions(+), 3 deletions(-)

diff --git a/src/main/java/de/neemann/digital/core/ObservableValue.java b/src/main/java/de/neemann/digital/core/ObservableValue.java
index 262260419..fc8d06fee 100644
--- a/src/main/java/de/neemann/digital/core/ObservableValue.java
+++ b/src/main/java/de/neemann/digital/core/ObservableValue.java
@@ -5,6 +5,12 @@ import de.neemann.digital.core.element.PinDescription;
 import de.neemann.digital.lang.Lang;
 
 /**
+ * Represents all signal values in the simulator.
+ * There are some setters to set the value. A value can be set to high z state.
+ * Only a complete bus can be set to high z state. It is not possible to set
+ * a single bit of a bus to high z state.
+ * Observers can observe this value to be notified if the value changes.
+ *
  * @author hneemann
  */
 public class ObservableValue extends Observable implements PinDescription {
diff --git a/src/main/java/de/neemann/digital/core/wiring/Delay.java b/src/main/java/de/neemann/digital/core/wiring/Delay.java
index 8081a9d96..b285af5eb 100644
--- a/src/main/java/de/neemann/digital/core/wiring/Delay.java
+++ b/src/main/java/de/neemann/digital/core/wiring/Delay.java
@@ -12,7 +12,9 @@ import de.neemann.digital.core.element.Keys;
 import static de.neemann.digital.core.element.PinInfo.input;
 
 /**
- * The Delay
+ * The Delay.
+ * Allows to delay a signal propagation by a certain amount of time.
+ * This time is given in units of gate delays.
  *
  * @author hneemann
  */
diff --git a/src/main/java/de/neemann/digital/core/wiring/bus/CommonBusValue.java b/src/main/java/de/neemann/digital/core/wiring/bus/CommonBusValue.java
index f82211e1e..c2f9b1bdb 100644
--- a/src/main/java/de/neemann/digital/core/wiring/bus/CommonBusValue.java
+++ b/src/main/java/de/neemann/digital/core/wiring/bus/CommonBusValue.java
@@ -9,7 +9,8 @@ import java.io.File;
 import java.util.Arrays;
 
 /**
- * This observer is added to all outputs connected together
+ * This observer represents the common output value of several outputs connected together.
+ * Handles also the switches.
  */
 public final class CommonBusValue extends ObservableValue implements NodeInterface {
     private final BusModelStateObserver obs;
diff --git a/src/test/java/de/neemann/digital/integration/FileScanner.java b/src/test/java/de/neemann/digital/integration/FileScanner.java
index 7f645ffaf..0f1ad6c5d 100644
--- a/src/test/java/de/neemann/digital/integration/FileScanner.java
+++ b/src/test/java/de/neemann/digital/integration/FileScanner.java
@@ -45,7 +45,7 @@ public class FileScanner {
             System.err.println("----> error in: " + e.f);
             e.e.printStackTrace();
         }
-        throw new Exception("errors testing files");
+        throw new Exception("errors testing files: " + errors.size());
     }
 
     private int scanIntern(File path) throws Exception {