diff --git a/src/main/java/projekt/enigma/model/Codebuch.java b/src/main/java/projekt/enigma/model/Codebuch.java index d2ab4a6bec190fb04459e49a5cd2d45093ce073a..b710a0a6ec7e524cbfc9df59adec6f1ea2eb1dfd 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 ce401e31527f9a557c8b505c0ed3cc7b8b6a67c9..8631af6186be26701d629893a62ba15d82c94ee0 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 f188a2c935d9c0f622502e1bd92a18a99a293727..0ddd8ed605bc771ee67247e6e3a3e39bd669add3 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