Javadoc-Fehler korrigiert

oboehm · Jan 7, 2024 · ef025c5 · ef025c5
1 parent 0bc96aa
commit ef025c5
Show file tree

Hide file tree

Showing 7 changed files with 187 additions and 120 deletions.
diff --git a/lib/src/main/java/gdv/xport/feld/Align.java b/lib/src/main/java/gdv/xport/feld/Align.java
@@ -39,10 +39,21 @@ public enum Align {
         code = (byte) n;
     }
 
+    /**
+     * Liefert den Code zurueck.
+     *
+     * @return 1 oder 2
+     */
     public byte getCode() {
         return code;
     }
 
+    /**
+     * Wandelt das uebergebene Byte in ein Aling-Objekt um.
+     *
+     * @param b 1 oder 2
+     * @return LEFT oder RIGHT
+     */
     public static Align of(byte b) {
         switch (b) {
             case 1:

diff --git a/lib/src/main/java/gdv/xport/feld/AlphaNumFeld.java b/lib/src/main/java/gdv/xport/feld/AlphaNumFeld.java
@@ -102,6 +102,12 @@ public AlphaNumFeld(final Feld other) {
         super(other);
     }
 
+    /**
+     * Dies ist der Copy-Constructor mit einem Feld mit neuer Konfiguration.
+     *
+     * @param other das originale Feld
+     * @param c     Konfiguration
+     */
     protected AlphaNumFeld(AlphaNumFeld other, Config c) {
         super(other, c);
     }
@@ -161,10 +167,18 @@ public List<ConstraintViolation> validate(Config validationConfig) {
      */
     public static class Validator extends Feld.Validator {
 
+        /**
+         * Default-Constructor.
+         */
         public Validator() {
             super();
         }
 
+        /**
+         * Legt einen Validator mit der angegebenen Konfiguration an.
+         *
+         * @param config Konfiguration
+         */
         public Validator(Config config) {
             super(config);
         }

diff --git a/lib/src/main/java/gdv/xport/feld/Betrag.java b/lib/src/main/java/gdv/xport/feld/Betrag.java
@@ -67,12 +67,29 @@ private Betrag(final Bezeichner name, final int length, final ByteAdresse start,
         super(name, length, start, 2, config);
     }
 
-    @Deprecated // TODO: wird mit v8 entsorgt
+    /**
+     * Legt einen neuen Betrag an.
+     *
+     * @param name   Name
+     * @param start  Start-Adresse
+     * @param value  Wert
+     * @param config Konfiguration
+     * @deprecated wird mit v8 entsorgt (TODO)
+     */
+    @Deprecated
     protected Betrag(final Bezeichner name, final int start, final String value, Config config) {
         this(name, value.length(), ByteAdresse.of(start), config);
         this.setInhalt(value);
     }
 
+    /**
+     * Legt einen neuen Betrag an.
+     *
+     * @param name   Name
+     * @param start  Start-Adresse
+     * @param value  Wert
+     * @param config Konfiguration
+     */
     protected Betrag(final Bezeichner name, final ByteAdresse start, final String value, Config config) {
         this(name, value.length(), start, config);
         this.setInhalt(value);
@@ -109,6 +126,12 @@ public Object clone() {
         return new Betrag(this);
     }
 
+    /**
+     * Erzeugt einen Betrag mit den Daten des uebergebenen Feldes.
+     *
+     * @param feld Feld
+     * @return Betrag
+     */
     public static Betrag of(Feld feld) {
         Betrag betrag = new Betrag(feld.getBezeichner(), feld.getAnzahlBytes(), feld.getByteAdresse());
         betrag.setInhalt(feld.getInhalt());

diff --git a/lib/src/main/java/gdv/xport/feld/BetragMitVorzeichen.java b/lib/src/main/java/gdv/xport/feld/BetragMitVorzeichen.java
@@ -299,10 +299,18 @@ public static BetragMitVorzeichen of(NumFeld betrag, AlphaNumFeld vorzeichen) {
      */
     public static class Validator extends NumFeld.Validator {
 
+        /**
+         * Default-Constructor.
+         */
         public Validator() {
             super();
         }
 
+        /**
+         * Legt einen Validator mit der angegebenen Konfiguration an.
+         *
+         * @param config Konfiguration
+         */
         public Validator(Config config) {
             super(config);
         }

diff --git a/lib/src/main/java/gdv/xport/feld/Bezeichner.java b/lib/src/main/java/gdv/xport/feld/Bezeichner.java
diff --git a/lib/src/main/java/gdv/xport/feld/Feld.java b/lib/src/main/java/gdv/xport/feld/Feld.java
@@ -601,6 +601,12 @@ public List<ConstraintViolation> validate() {
         return validate(Config.LAX);
     }
 
+    /**
+     * Validiert das Feld mit der angegebenen Konfiguration.
+     *
+     * @param validationConfig Konfiguration
+     * @return Liste mit Validierungsfehler
+     */
     public List<ConstraintViolation> validate(Config validationConfig) {
         List<ConstraintViolation> violations = validateInvariants();
         if (this.getEndAdresse() > 256) {

diff --git a/lib/src/main/java/gdv/xport/util/AbstractFormatter.java b/lib/src/main/java/gdv/xport/util/AbstractFormatter.java
@@ -39,6 +39,12 @@ public AbstractFormatter(final Writer writer) {
         this(writer, Config.getInstance());
     }
 
+    /**
+     * Legt einen neuen Formatter an.
+     *
+     * @param writer Writer
+     * @param config Konfiguration
+     */
     protected AbstractFormatter(final Writer writer, final Config config) {
         this.writer = writer;
         this.config = config;
@@ -53,6 +59,11 @@ public AbstractFormatter(final OutputStream ostream) {
         this(new OutputStreamWriter(ostream, Config.DEFAULT_ENCODING));
     }
 
+    /**
+     * Liefert die Konfiguratipn zurueck.
+     *
+     * @return Konfiguration
+     */
     protected final Config getConfig() {
         return config;
     }