From adbc29dabeeccd52e9b7f2a0cea4a98157ce0f11 Mon Sep 17 00:00:00 2001 From: "J. Neugebauer" Date: Wed, 14 Dec 2022 20:36:08 +0100 Subject: [PATCH] Dokumentation --- src/main/java/schule/ngb/zm/util/Counter.java | 2 +- src/main/java/schule/ngb/zm/util/Faker.java | 2 +- src/main/java/schule/ngb/zm/util/Timer.java | 2 +- src/main/java/schule/ngb/zm/util/events/package-info.java | 2 +- src/main/java/schule/ngb/zm/util/io/FileLoader.java | 2 +- src/main/java/schule/ngb/zm/util/io/FontLoader.java | 2 +- src/main/java/schule/ngb/zm/util/io/ImageLoader.java | 2 +- src/main/java/schule/ngb/zm/util/io/ResourceStreamProvider.java | 2 +- src/main/java/schule/ngb/zm/util/io/package-info.java | 2 +- src/main/java/schule/ngb/zm/util/package-info.java | 2 +- src/main/java/schule/ngb/zm/util/tasks/package-info.java | 2 +- 11 files changed, 11 insertions(+), 11 deletions(-) diff --git a/src/main/java/schule/ngb/zm/util/Counter.java b/src/main/java/schule/ngb/zm/util/Counter.java index acf41fa..295a8dd 100644 --- a/src/main/java/schule/ngb/zm/util/Counter.java +++ b/src/main/java/schule/ngb/zm/util/Counter.java @@ -5,7 +5,7 @@ import java.util.List; import java.util.concurrent.atomic.AtomicInteger; /** - * Eine Helferklasse, um Dinge zu zählen. + * Eine Hilfsklasse, um Dinge zu zählen. *

* Im einfachsten Fall kann der Zähler als geteilte Zählvariable genutzt werden, * die mit {@link #inc()} und {@link #dec()} aus verschiedenen Objekten oder diff --git a/src/main/java/schule/ngb/zm/util/Faker.java b/src/main/java/schule/ngb/zm/util/Faker.java index cb4d0d7..a72d6c0 100644 --- a/src/main/java/schule/ngb/zm/util/Faker.java +++ b/src/main/java/schule/ngb/zm/util/Faker.java @@ -28,7 +28,7 @@ import static java.lang.Math.log; import static schule.ngb.zm.Constants.random; /** - * Eine Helferklasse, um zufällige Beispieldaten zu erzeugen. + * Eine Hilfsklasse, um zufällige Beispieldaten zu erzeugen. *

* Die Klasse kann verschiedene Arten realistischer Beispieldaten erzeugen. * Unter anderem Namen, E-Mail-Adressen, Passwörter oder Platzhalter-Bilder. diff --git a/src/main/java/schule/ngb/zm/util/Timer.java b/src/main/java/schule/ngb/zm/util/Timer.java index fdbc011..80d431b 100644 --- a/src/main/java/schule/ngb/zm/util/Timer.java +++ b/src/main/java/schule/ngb/zm/util/Timer.java @@ -3,7 +3,7 @@ package schule.ngb.zm.util; import java.util.concurrent.TimeUnit; /** - * Helferklasse zur Zeitmessung im Nanosekundenbereich. + * Hilfsklasse zur Zeitmessung im Nanosekundenbereich. *

* Mit einem {@code Timer} kann zum Beispiel die Laufzeit eines Algorithmus * gemessen werden. Wie eine echte Stoppuhr läuft der {@code Timer} weiter, wenn diff --git a/src/main/java/schule/ngb/zm/util/events/package-info.java b/src/main/java/schule/ngb/zm/util/events/package-info.java index f8dc5c7..6e1bff0 100644 --- a/src/main/java/schule/ngb/zm/util/events/package-info.java +++ b/src/main/java/schule/ngb/zm/util/events/package-info.java @@ -1,5 +1,5 @@ /** - * Dieses Paket enthält Helferklassen, die das Listener-Entwurfsmuster + * Dieses Paket enthält Hilfsklassen, die das Listener-Entwurfsmuster * umsetzen. */ package schule.ngb.zm.util.events; diff --git a/src/main/java/schule/ngb/zm/util/io/FileLoader.java b/src/main/java/schule/ngb/zm/util/io/FileLoader.java index 795d592..375e5d3 100644 --- a/src/main/java/schule/ngb/zm/util/io/FileLoader.java +++ b/src/main/java/schule/ngb/zm/util/io/FileLoader.java @@ -13,7 +13,7 @@ import java.util.List; import java.util.function.Function; /** - * Helferklasse, um Textdateien in verschiedenen Formaten einzulesen. + * Hilfsklasse, um Textdateien in verschiedenen Formaten einzulesen. */ @SuppressWarnings( "unused" ) public final class FileLoader { diff --git a/src/main/java/schule/ngb/zm/util/io/FontLoader.java b/src/main/java/schule/ngb/zm/util/io/FontLoader.java index 997d5bb..9a2075c 100644 --- a/src/main/java/schule/ngb/zm/util/io/FontLoader.java +++ b/src/main/java/schule/ngb/zm/util/io/FontLoader.java @@ -14,7 +14,7 @@ import java.util.Map; import java.util.concurrent.ConcurrentHashMap; /** - * Eine Helferklasse mit Klassenmethoden, um Schriftarten zu laden. + * Eine Hilfsklasse mit Klassenmethoden, um Schriftarten zu laden. *

* Schriftarten können von verschiedenen Quellen geladen werden. Schriftarten, * die aus Dateien geladen wurden, werden in einem internen Cache gespeichert diff --git a/src/main/java/schule/ngb/zm/util/io/ImageLoader.java b/src/main/java/schule/ngb/zm/util/io/ImageLoader.java index e05fb69..7ed5528 100644 --- a/src/main/java/schule/ngb/zm/util/io/ImageLoader.java +++ b/src/main/java/schule/ngb/zm/util/io/ImageLoader.java @@ -18,7 +18,7 @@ import java.io.InputStream; import java.lang.ref.SoftReference; /** - * Eine Helferklasse mit Klassenmethoden, um Bilder zu laden. + * Eine Hilfsklasse mit Klassenmethoden, um Bilder zu laden. *

* Bilder können von verschiedenen Quellen als {@link Image} geladen werden. Die * Objekte werden in einem internen Cache gespeichert und nachfolgende Versuche, diff --git a/src/main/java/schule/ngb/zm/util/io/ResourceStreamProvider.java b/src/main/java/schule/ngb/zm/util/io/ResourceStreamProvider.java index 9620ca9..ed921c3 100644 --- a/src/main/java/schule/ngb/zm/util/io/ResourceStreamProvider.java +++ b/src/main/java/schule/ngb/zm/util/io/ResourceStreamProvider.java @@ -13,7 +13,7 @@ import java.nio.file.Files; import java.nio.file.Path; /** - * Helferklasse, um {@link InputStream}s für Ressourcen zu erhalten. + * Hilfsklasse, um {@link InputStream}s für Ressourcen zu erhalten. */ @SuppressWarnings("unused") public class ResourceStreamProvider { diff --git a/src/main/java/schule/ngb/zm/util/io/package-info.java b/src/main/java/schule/ngb/zm/util/io/package-info.java index 454b624..39ef542 100644 --- a/src/main/java/schule/ngb/zm/util/io/package-info.java +++ b/src/main/java/schule/ngb/zm/util/io/package-info.java @@ -1,5 +1,5 @@ /** - * Dieses Paket enthält Helferklassen, um Ressourcen aus verschiedenen Quellen + * Dieses Paket enthält Hilfsklassen, um Ressourcen aus verschiedenen Quellen * zu laden. */ package schule.ngb.zm.util.io; diff --git a/src/main/java/schule/ngb/zm/util/package-info.java b/src/main/java/schule/ngb/zm/util/package-info.java index 1e6134b..210ecd1 100644 --- a/src/main/java/schule/ngb/zm/util/package-info.java +++ b/src/main/java/schule/ngb/zm/util/package-info.java @@ -1,4 +1,4 @@ /** - * Dieses Paket enthält Helferklassen für verschiedene Einsatzzwecke. + * Dieses Paket enthält Hilfsklassen für verschiedene Einsatzzwecke. */ package schule.ngb.zm.util; diff --git a/src/main/java/schule/ngb/zm/util/tasks/package-info.java b/src/main/java/schule/ngb/zm/util/tasks/package-info.java index 6bdbdaa..400d1d2 100644 --- a/src/main/java/schule/ngb/zm/util/tasks/package-info.java +++ b/src/main/java/schule/ngb/zm/util/tasks/package-info.java @@ -1,5 +1,5 @@ /** - * Dieses Paket enthält Helferklassen zur Verarbeitung paralleler Aufgaben + * Dieses Paket enthält Hilfsklassen zur Ausführung paralleler Aufgaben * innerhalb der Zeichenmaschine. */ package schule.ngb.zm.util.tasks;