docs: add package-info.java for demo packages
authorSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Sun, 15 Mar 2026 22:30:04 +0000 (00:30 +0200)
committerSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Sun, 15 Mar 2026 22:30:04 +0000 (00:30 +0200)
Add package-level documentation for:

- galaxy_demo (spiral galaxy visualization)

- launcher (demo GUI launcher)

- life_demo (Conway's Game of Life in 3D)

src/main/java/eu/svjatoslav/sixth/e3d/examples/galaxy_demo/package-info.java [new file with mode: 0644]
src/main/java/eu/svjatoslav/sixth/e3d/examples/launcher/package-info.java [new file with mode: 0644]
src/main/java/eu/svjatoslav/sixth/e3d/examples/life_demo/package-info.java [new file with mode: 0644]

diff --git a/src/main/java/eu/svjatoslav/sixth/e3d/examples/galaxy_demo/package-info.java b/src/main/java/eu/svjatoslav/sixth/e3d/examples/galaxy_demo/package-info.java
new file mode 100644 (file)
index 0000000..a80d64b
--- /dev/null
@@ -0,0 +1,22 @@
+/*
+ * Sixth 3D engine demos. Author: Svjatoslav Agejenko.
+ * This project is released under Creative Commons Zero (CC0) license.
+ */
+
+/**
+ * Galaxy simulation demo using glowing points.
+ *
+ * <p>Creates a spiral galaxy visualization using
+ * {@link eu.svjatoslav.sixth.e3d.renderer.raster.shapes.basic.GlowingPoint}
+ * shapes arranged in a mathematical spiral pattern.</p>
+ *
+ * <p>Key classes:</p>
+ * <ul>
+ *   <li>{@link eu.svjatoslav.sixth.e3d.examples.galaxy_demo.Galaxy} - The galaxy shape</li>
+ *   <li>{@link eu.svjatoslav.sixth.e3d.examples.galaxy_demo.PointCloudDemo} - Demo entry point</li>
+ * </ul>
+ *
+ * @see eu.svjatoslav.sixth.e3d.examples.galaxy_demo.Galaxy
+ */
+
+package eu.svjatoslav.sixth.e3d.examples.galaxy_demo;
\ No newline at end of file
diff --git a/src/main/java/eu/svjatoslav/sixth/e3d/examples/launcher/package-info.java b/src/main/java/eu/svjatoslav/sixth/e3d/examples/launcher/package-info.java
new file mode 100644 (file)
index 0000000..560327b
--- /dev/null
@@ -0,0 +1,15 @@
+/*
+ * Sixth 3D engine demos. Author: Svjatoslav Agejenko.
+ * This project is released under Creative Commons Zero (CC0) license.
+ */
+
+/**
+ * Demo launcher application.
+ *
+ * <p>Provides a GUI window with buttons to launch each demo application.
+ * The main entry point is {@link eu.svjatoslav.sixth.e3d.examples.launcher.Main}.</p>
+ *
+ * @see eu.svjatoslav.sixth.e3d.examples.launcher.Main
+ */
+
+package eu.svjatoslav.sixth.e3d.examples.launcher;
\ No newline at end of file
diff --git a/src/main/java/eu/svjatoslav/sixth/e3d/examples/life_demo/package-info.java b/src/main/java/eu/svjatoslav/sixth/e3d/examples/life_demo/package-info.java
new file mode 100644 (file)
index 0000000..423b24b
--- /dev/null
@@ -0,0 +1,23 @@
+/*
+ * Sixth 3D engine demos. Author: Svjatoslav Agejenko.
+ * This project is released under Creative Commons Zero (CC0) license.
+ */
+
+/**
+ * Conway's Game of Life 3D demo.
+ *
+ * <p>Implements a 30x30 cell matrix where cells evolve based on Conway's rules.
+ * Users can interact by clicking to toggle cell states. The simulation runs
+ * in a 3D view with camera navigation.</p>
+ *
+ * <p>Key classes:</p>
+ * <ul>
+ *   <li>{@link eu.svjatoslav.sixth.e3d.examples.life_demo.Main} - Demo entry point</li>
+ *   <li>{@link eu.svjatoslav.sixth.e3d.examples.life_demo.Cell} - Individual cell representation</li>
+ *   <li>{@link eu.svjatoslav.sixth.e3d.examples.life_demo.Matrix} - The cell grid</li>
+ * </ul>
+ *
+ * @see eu.svjatoslav.sixth.e3d.examples.life_demo.Main
+ */
+
+package eu.svjatoslav.sixth.e3d.examples.life_demo;
\ No newline at end of file