From 0a0e9ca4e96e4679da674201bd479826ec63eaa1 Mon Sep 17 00:00:00 2001
From: hneemann <helmut.neemann@arcor.de>
Date: Tue, 17 Jul 2018 20:15:08 +0200
Subject: [PATCH] fixed RelayDT documentation

---
 .../de/neemann/digital/core/element/PinDescription.java  | 5 +++++
 .../java/de/neemann/digital/core/switching/RelayDT.java  | 9 +++------
 .../digital/gui/components/ElementHelpDialog.java        | 7 +++++--
 src/test/java/de/neemann/digital/docu/DocuTest.java      | 9 ++++++---
 4 files changed, 19 insertions(+), 11 deletions(-)

diff --git a/src/main/java/de/neemann/digital/core/element/PinDescription.java b/src/main/java/de/neemann/digital/core/element/PinDescription.java
index 17b24faf3..b366865e3 100644
--- a/src/main/java/de/neemann/digital/core/element/PinDescription.java
+++ b/src/main/java/de/neemann/digital/core/element/PinDescription.java
@@ -10,6 +10,11 @@ package de.neemann.digital.core.element;
  */
 public interface PinDescription {
 
+    /**
+     * If the description is set to this value, the pin is ignored in the documentation.
+     */
+    String IGNORE = "ignore";
+
     /**
      * The possible pull resistor configurations
      * "both" is an error condition which can happen if nets are merged
diff --git a/src/main/java/de/neemann/digital/core/switching/RelayDT.java b/src/main/java/de/neemann/digital/core/switching/RelayDT.java
index 40c9cd921..f69cd5700 100644
--- a/src/main/java/de/neemann/digital/core/switching/RelayDT.java
+++ b/src/main/java/de/neemann/digital/core/switching/RelayDT.java
@@ -6,10 +6,7 @@
 package de.neemann.digital.core.switching;
 
 import de.neemann.digital.core.*;
-import de.neemann.digital.core.element.Element;
-import de.neemann.digital.core.element.ElementAttributes;
-import de.neemann.digital.core.element.ElementTypeDescription;
-import de.neemann.digital.core.element.Keys;
+import de.neemann.digital.core.element.*;
 
 import static de.neemann.digital.core.element.PinInfo.input;
 
@@ -103,8 +100,8 @@ public class RelayDT extends Node implements Element {
 
 
         private Pole(int bits, int num) {
-            outputAB = new ObservableValue("AB" + num, bits).setBidirectional().setToHighZ();
-            outputAC = new ObservableValue("AC" + num, bits).setBidirectional().setToHighZ();
+            outputAB = new ObservableValue("A" + num, bits).setBidirectional().setToHighZ();
+            outputAC = new ObservableValue("AC" + num, bits).setBidirectional().setToHighZ().setDescription(PinDescription.IGNORE);
             outputB = new ObservableValue("B" + num, bits).setBidirectional().setToHighZ();
             outputC = new ObservableValue("C" + num, bits).setBidirectional().setToHighZ();
             s1 = new Switch(outputAB, outputB, false);
diff --git a/src/main/java/de/neemann/digital/gui/components/ElementHelpDialog.java b/src/main/java/de/neemann/digital/gui/components/ElementHelpDialog.java
index 474bcc31f..204433c52 100644
--- a/src/main/java/de/neemann/digital/gui/components/ElementHelpDialog.java
+++ b/src/main/java/de/neemann/digital/gui/components/ElementHelpDialog.java
@@ -223,8 +223,11 @@ public class ElementHelpDialog extends JDialog {
         PinDescriptions outputs = et.getOutputDescriptions(elementAttributes);
         if (outputs != null && outputs.size() > 0) {
             w.append("<h4>").append(Lang.get("elem_Help_outputs")).append(":</h4>\n<dl>\n");
-            for (PinDescription i : outputs)
-                writeEntry(w, ElementAttributes.cleanLabel(i.getName()), i.getDescription());
+            for (PinDescription i : outputs) {
+                final String description = i.getDescription();
+                if (description != PinDescription.IGNORE)
+                    writeEntry(w, ElementAttributes.cleanLabel(i.getName()), description);
+            }
             w.append("</dl>\n");
         }
 
diff --git a/src/test/java/de/neemann/digital/docu/DocuTest.java b/src/test/java/de/neemann/digital/docu/DocuTest.java
index 5caee1dc3..3a1b4ac62 100644
--- a/src/test/java/de/neemann/digital/docu/DocuTest.java
+++ b/src/test/java/de/neemann/digital/docu/DocuTest.java
@@ -151,9 +151,12 @@ public class DocuTest extends TestCase {
 
     private void writePins(Writer w, PinDescriptions pinDescriptions) throws IOException {
         for (PinDescription p : pinDescriptions) {
-            w.append("        <pin name=\"").append(escapeHTML(p.getName())).append("\">");
-            w.append(escapeHTML(p.getDescription()));
-            w.append("</pin>\n");
+            final String description = p.getDescription();
+            if (description != PinDescription.IGNORE) {
+                w.append("        <pin name=\"").append(escapeHTML(p.getName())).append("\">");
+                w.append(escapeHTML(description));
+                w.append("</pin>\n");
+            }
         }
     }