From a94d45176f48031ca2d5675baa01a6146065aba2 Mon Sep 17 00:00:00 2001
From: Michael <micha.bechtel@web.de>
Date: Wed, 4 Dec 2019 14:23:58 +0100
Subject: [PATCH] Kommentare hinzugefuegt
---
src/main/java/projekt/enigma/model/Codebuch.java | 7 +++----
src/main/java/projekt/enigma/model/Codierer.java | 10 ++++++----
src/main/java/projekt/enigma/model/Hardware.java | 10 +++++++++-
3 files changed, 18 insertions(+), 9 deletions(-)
diff --git a/src/main/java/projekt/enigma/model/Codebuch.java b/src/main/java/projekt/enigma/model/Codebuch.java
index d2ab4a6..b710a0a 100644
--- a/src/main/java/projekt/enigma/model/Codebuch.java
+++ b/src/main/java/projekt/enigma/model/Codebuch.java
@@ -25,18 +25,17 @@ public class Codebuch {
//region Variablen
/**
- * TODO: Dokumentieren tag
- * tag : int : gibt den Tag an
+ * tag : int : gibt den Tag eines Monats an
*/
private int tag;
/**
- * walzenlage : int[] : legt die Positionen der Walzen fest
+ * walzenlage : int[] : legt die Positionen der drei Walzen fest
*/
private int[] walzenlage;
/**
- * ringstellung : int[] : TODO ringstellung: char || int ?
+ * ringstellung : int[] : legt die Ringstellungen der drei Walzen fest
*/
private int[] ringstellung;
diff --git a/src/main/java/projekt/enigma/model/Codierer.java b/src/main/java/projekt/enigma/model/Codierer.java
index ce401e3..8631af6 100644
--- a/src/main/java/projekt/enigma/model/Codierer.java
+++ b/src/main/java/projekt/enigma/model/Codierer.java
@@ -46,7 +46,9 @@ public class Codierer {
*/
private Codebuch codebuch;
- //TODO Dokumentieren
+ /**
+ * Thread mit der Abfolge an Aufgaben des Funkraums.
+ */
private Thread funk;
//endregion
@@ -344,10 +346,10 @@ public class Codierer {
}
/**
- * TODO: Doku
+ * Ueberprueft welche Buchstaben noch zur Vertauschung verfügbar sind
*
- * @param port
- * @return
+ * @param port: Zahl zwischen 0-9: entspricht der Kabelnummer.
+ * @return String: liefert einen String mit den verfuegbaren Buchstaben zurueck.
*/
public String fetchVerfuegbareBuchstaben(int port) {
return this.hardware.getSteckbrett().fetchVerfuegbareBuchstaben(port);
diff --git a/src/main/java/projekt/enigma/model/Hardware.java b/src/main/java/projekt/enigma/model/Hardware.java
index f188a2c..0ddd8ed 100644
--- a/src/main/java/projekt/enigma/model/Hardware.java
+++ b/src/main/java/projekt/enigma/model/Hardware.java
@@ -17,10 +17,18 @@ public class Hardware {
//region Variablen
/**
- * TODO: Dokumentieren
+ * walzen: Walze-Array: erzeugt ein privates Array mit der die Anzahl der Walzen festgelegt wird.
*/
private Walze[] walzen;
+
+ /**
+ * steckbrett: Steckbrett: erzeugt ein privates Steckbrett-Objekt
+ */
private Steckbrett steckbrett;
+
+ /**
+ * reflektor: Reflektor: erzeugt ein privates Reflektor-Objekt.
+ */
private Reflektor reflektor;
//endregion
--
GitLab