diff --git a/src/main/java/schule/ngb/zm/anim/package-info.java b/src/main/java/schule/ngb/zm/anim/package-info.java new file mode 100644 index 0000000..b6cc4f2 --- /dev/null +++ b/src/main/java/schule/ngb/zm/anim/package-info.java @@ -0,0 +1,12 @@ +/** + * Dieses Paket enthält Klassen zur Animation von + * {@link schule.ngb.zm.shapes.Shape} Objekten auf einem + * {@link schule.ngb.zm.layers.ShapesLayer}. + *
+ * Mit den Animationsklassen lassen sich neben {@code Shape} Objekten aber auch + * andere Objekte animieren. + *
+ * Das Paket setzt auf den funktionalen Programmierschnittstellen von Java auf + * und kann als Einführung in das Paradigma dienen. + */ +package schule.ngb.zm.anim; diff --git a/src/main/java/schule/ngb/zm/layers/package-info.java b/src/main/java/schule/ngb/zm/layers/package-info.java new file mode 100644 index 0000000..dc19c74 --- /dev/null +++ b/src/main/java/schule/ngb/zm/layers/package-info.java @@ -0,0 +1,8 @@ +/** + * Dieses Paket enthält implementationen der abstrakten + * {@link schule.ngb.zm.Layer} Klasse. + *
+ * {@code Layer} sind Ebenen, die der {@link schule.ngb.zm.Zeichenleinwand} + * hinzugefügt und pro Frame gerendert werden. + */ +package schule.ngb.zm.layers; diff --git a/src/main/java/schule/ngb/zm/media/package-info.java b/src/main/java/schule/ngb/zm/media/package-info.java new file mode 100644 index 0000000..37d032a --- /dev/null +++ b/src/main/java/schule/ngb/zm/media/package-info.java @@ -0,0 +1,7 @@ +/** + * Dieses Paket enthält Klassen zur Einbettung von Mediendateien. + *
+ * Mit Medien sind vor allem Audio und Videodateien gemeint. Aktuell kann die + * Zeichenmaschine Audiodateien verwenden. + */ +package schule.ngb.zm.media; diff --git a/src/main/java/schule/ngb/zm/ml/package-info.java b/src/main/java/schule/ngb/zm/ml/package-info.java new file mode 100644 index 0000000..9476bb2 --- /dev/null +++ b/src/main/java/schule/ngb/zm/ml/package-info.java @@ -0,0 +1,16 @@ +/** + * Dieses Paekt enthält Klassen für Experimente mit Verfahren des maschinellen + * Lernens (ML). + *
+ * Die hier implementierten Klassen sind eine prototypische Umsetzung von + * einfachen neuronalen Netzwerken, mit denen an kleinen Problemstellungen + * experimentell Modelle trainiert und angewandt werden können. + *
+ * Die Implementierungen sind nicht optimiert und setzen auf native + * Java-Methoden. Daher sind sie nur für die Anwendung auf extrem kleine Modelle + * in Bildungskontexten gedacht. + *
+ * Durch Einbettung wissenschaftlicher Bibliotheken mit optimierten Operationen + * lassen sich bessere Ergebnisse erreichen. + */ +package schule.ngb.zm.ml; diff --git a/src/main/java/schule/ngb/zm/package-info.java b/src/main/java/schule/ngb/zm/package-info.java new file mode 100644 index 0000000..08f50a9 --- /dev/null +++ b/src/main/java/schule/ngb/zm/package-info.java @@ -0,0 +1,13 @@ +/** + *
+ * Die Zeichenmaschine ist eine für den Informatikunterricht entwickelte + * Bibliothek, die unter anderem an Processing angelehnt ist. Die Bibliothek + * soll einige der üblichen Anfängerschwierigkeiten mit Java vereinfachen und + * für Schülerinnen und Schüler im Unterricht nutzbar machen. + *
+ * Eine umfassende Dokumentation ist unter zeichenmaschine.xyz verfügbar. + */ +package schule.ngb.zm; diff --git a/src/main/java/schule/ngb/zm/shapes/charts/package-info.java b/src/main/java/schule/ngb/zm/shapes/charts/package-info.java new file mode 100644 index 0000000..683a001 --- /dev/null +++ b/src/main/java/schule/ngb/zm/shapes/charts/package-info.java @@ -0,0 +1,4 @@ +/** + * Diese Paket enthält Formen, die Diagramme darstellen. + */ +package schule.ngb.zm.shapes.charts; diff --git a/src/main/java/schule/ngb/zm/shapes/package-info.java b/src/main/java/schule/ngb/zm/shapes/package-info.java new file mode 100644 index 0000000..94a4708 --- /dev/null +++ b/src/main/java/schule/ngb/zm/shapes/package-info.java @@ -0,0 +1,13 @@ +/** + * Dieses Paket enthält Implementationen der abstrakten + * {@link schule.ngb.zm.shapes.Shape} Klasse. + * + * Jede Unterklasse von {@code Shape} stellt eine konkrete Form wie ein + * {@link schule.ngb.zm.shapes.Rectangle Rechteck}, ein + * {@link schule.ngb.zm.shapes.Circle Kreis} oder ein + * {@link schule.ngb.zm.shapes.Picture Bild} dar. + * + * Mit {@link schule.ngb.zm.shapes.ShapeGroup} können Formen gruppiert + * und gemeinsam transformiert werden. + */ +package schule.ngb.zm.shapes; 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 new file mode 100644 index 0000000..f8dc5c7 --- /dev/null +++ b/src/main/java/schule/ngb/zm/util/events/package-info.java @@ -0,0 +1,5 @@ +/** + * Dieses Paket enthält Helferklassen, die das Listener-Entwurfsmuster + * umsetzen. + */ +package schule.ngb.zm.util.events; 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 new file mode 100644 index 0000000..454b624 --- /dev/null +++ b/src/main/java/schule/ngb/zm/util/io/package-info.java @@ -0,0 +1,5 @@ +/** + * Dieses Paket enthält Helferklassen, 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 new file mode 100644 index 0000000..1e6134b --- /dev/null +++ b/src/main/java/schule/ngb/zm/util/package-info.java @@ -0,0 +1,4 @@ +/** + * Dieses Paket enthält Helferklassen 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 new file mode 100644 index 0000000..6bdbdaa --- /dev/null +++ b/src/main/java/schule/ngb/zm/util/tasks/package-info.java @@ -0,0 +1,5 @@ +/** + * Dieses Paket enthält Helferklassen zur Verarbeitung paralleler Aufgaben + * innerhalb der Zeichenmaschine. + */ +package schule.ngb.zm.util.tasks;