Dokumentation

This commit is contained in:
ngb
2022-12-14 20:36:08 +01:00
parent b687483e6d
commit adbc29dabe
11 changed files with 11 additions and 11 deletions

View File

@@ -5,7 +5,7 @@ import java.util.List;
import java.util.concurrent.atomic.AtomicInteger; import java.util.concurrent.atomic.AtomicInteger;
/** /**
* Eine Helferklasse, um Dinge zu zählen. * Eine Hilfsklasse, um Dinge zu zählen.
* <p> * <p>
* Im einfachsten Fall kann der Zähler als geteilte Zählvariable genutzt werden, * Im einfachsten Fall kann der Zähler als geteilte Zählvariable genutzt werden,
* die mit {@link #inc()} und {@link #dec()} aus verschiedenen Objekten oder * die mit {@link #inc()} und {@link #dec()} aus verschiedenen Objekten oder

View File

@@ -28,7 +28,7 @@ import static java.lang.Math.log;
import static schule.ngb.zm.Constants.random; import static schule.ngb.zm.Constants.random;
/** /**
* Eine Helferklasse, um zufällige Beispieldaten zu erzeugen. * Eine Hilfsklasse, um zufällige Beispieldaten zu erzeugen.
* <p> * <p>
* Die Klasse kann verschiedene Arten realistischer Beispieldaten erzeugen. * Die Klasse kann verschiedene Arten realistischer Beispieldaten erzeugen.
* Unter anderem Namen, E-Mail-Adressen, Passwörter oder Platzhalter-Bilder. * Unter anderem Namen, E-Mail-Adressen, Passwörter oder Platzhalter-Bilder.

View File

@@ -3,7 +3,7 @@ package schule.ngb.zm.util;
import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeUnit;
/** /**
* Helferklasse zur Zeitmessung im Nanosekundenbereich. * Hilfsklasse zur Zeitmessung im Nanosekundenbereich.
* <p> * <p>
* Mit einem {@code Timer} kann zum Beispiel die Laufzeit eines Algorithmus * Mit einem {@code Timer} kann zum Beispiel die Laufzeit eines Algorithmus
* gemessen werden. Wie eine echte Stoppuhr läuft der {@code Timer} weiter, wenn * gemessen werden. Wie eine echte Stoppuhr läuft der {@code Timer} weiter, wenn

View File

@@ -1,5 +1,5 @@
/** /**
* Dieses Paket enthält Helferklassen, die das Listener-Entwurfsmuster * Dieses Paket enthält Hilfsklassen, die das Listener-Entwurfsmuster
* umsetzen. * umsetzen.
*/ */
package schule.ngb.zm.util.events; package schule.ngb.zm.util.events;

View File

@@ -13,7 +13,7 @@ import java.util.List;
import java.util.function.Function; import java.util.function.Function;
/** /**
* Helferklasse, um Textdateien in verschiedenen Formaten einzulesen. * Hilfsklasse, um Textdateien in verschiedenen Formaten einzulesen.
*/ */
@SuppressWarnings( "unused" ) @SuppressWarnings( "unused" )
public final class FileLoader { public final class FileLoader {

View File

@@ -14,7 +14,7 @@ import java.util.Map;
import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentHashMap;
/** /**
* Eine Helferklasse mit Klassenmethoden, um Schriftarten zu laden. * Eine Hilfsklasse mit Klassenmethoden, um Schriftarten zu laden.
* <p> * <p>
* Schriftarten können von verschiedenen Quellen geladen werden. Schriftarten, * Schriftarten können von verschiedenen Quellen geladen werden. Schriftarten,
* die aus Dateien geladen wurden, werden in einem internen Cache gespeichert * die aus Dateien geladen wurden, werden in einem internen Cache gespeichert

View File

@@ -18,7 +18,7 @@ import java.io.InputStream;
import java.lang.ref.SoftReference; import java.lang.ref.SoftReference;
/** /**
* Eine Helferklasse mit Klassenmethoden, um Bilder zu laden. * Eine Hilfsklasse mit Klassenmethoden, um Bilder zu laden.
* <p> * <p>
* Bilder können von verschiedenen Quellen als {@link Image} geladen werden. Die * Bilder können von verschiedenen Quellen als {@link Image} geladen werden. Die
* Objekte werden in einem internen Cache gespeichert und nachfolgende Versuche, * Objekte werden in einem internen Cache gespeichert und nachfolgende Versuche,

View File

@@ -13,7 +13,7 @@ import java.nio.file.Files;
import java.nio.file.Path; 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") @SuppressWarnings("unused")
public class ResourceStreamProvider { public class ResourceStreamProvider {

View File

@@ -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. * zu laden.
*/ */
package schule.ngb.zm.util.io; package schule.ngb.zm.util.io;

View File

@@ -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; package schule.ngb.zm.util;

View File

@@ -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. * innerhalb der Zeichenmaschine.
*/ */
package schule.ngb.zm.util.tasks; package schule.ngb.zm.util.tasks;