Add & update package-info.java files

base/src/main/java/de/staropensource/sosengine/base/annotations/EngineSubsystem.java

@@ -22,7 +22,7 @@ package de.staropensource.sosengine.base.annotations;
 import java.lang.annotation.*;
 
 /**
- * Annotation for registering events on methods.
+ * This annotation marks a class as a subsystem main class.
  *
  * @since 1-alpha1
  */

base/src/main/java/de/staropensource/sosengine/base/annotations/EventListener.java

@@ -26,7 +26,7 @@ import org.jetbrains.annotations.NotNull;
 import java.lang.annotation.*;
 
 /**
- * Annotation for registering events on methods.
+ * This annotation allows methods to listen on certain events.
  *
  * @since 1-alpha0
  */

base/src/main/java/de/staropensource/sosengine/base/annotations/package-info.java

@@ -18,7 +18,8 @@
  */
 
 /**
- * Contains annotations.
+ * Contains annotations that are used by the engine
+ * to dynamically invoke methods or register classes.
  *
  * @since 1-alpha0
  */

base/src/main/java/de/staropensource/sosengine/base/classes/helpers/package-info.java

@@ -18,7 +18,8 @@
  */
 
 /**
- * Not necessarily interfaces or extendable classes. Rather, they support implementing classes by providing useful or complex code.
+ * Not necessarily interfaces or extendable classes. Rather, they
+ * support implementing classes by providing useful or complex code.
  *
  * @since 1-alpha0
  */

base/src/main/java/de/staropensource/sosengine/base/data/info/package-info.java

@@ -19,5 +19,7 @@
 
 /**
  * Provides various classes that can be used to retrieve information about the engine or JVM.
+ *
+ * @since 1-alpha0
  */
 package de.staropensource.sosengine.base.data.info;

base/src/main/java/de/staropensource/sosengine/base/data/versioning/FourNumberVersioningSystem.java

@@ -107,7 +107,7 @@ public final class FourNumberVersioningSystem implements VersioningSystem {
         // Escape separator or throw error if invalid
         switch (separator) {
             case "." -> separator = "\\.";
-            case null -> throw new InvalidVersionStringException(this, versionString, "No matching separator could be found. Required are either three dots ('.') or hyphens ('-').");
+            case null -> throw new InvalidVersionStringException(this, versionString, "No matching separator could be found. Required are either three dots ('.') or hyphens ('-')");
             default -> {}
         }
 
@@ -121,7 +121,7 @@ public final class FourNumberVersioningSystem implements VersioningSystem {
             this.number3 = Integer.parseUnsignedInt(versionStringSplit[2]);
             this.number4 = Integer.parseUnsignedInt(versionStringSplit[3]);
         } catch (NumberFormatException exception) {
-            throw new InvalidVersionStringException(this, versionString, "Failed converting one of the vectors to an integer.", exception);
+            throw new InvalidVersionStringException(this, versionString, "Failed converting one of the vectors to an integer", exception);
         }
     }
 

base/src/main/java/de/staropensource/sosengine/base/data/versioning/SemanticVersioningSystem.java

@@ -126,7 +126,7 @@ public final class SemanticVersioningSystem implements VersioningSystem {
         // Escape separator or throw error if invalid
         switch (separator) {
             case "." -> separator = "\\.";
-            case null -> throw new InvalidVersionStringException(this, versionString, "No matching separator could be found. Required are two dots ('.').");
+            case null -> throw new InvalidVersionStringException(this, versionString, "No matching separator could be found. Required are two dots ('.')");
             default -> {}
         }
 
@@ -158,7 +158,7 @@ public final class SemanticVersioningSystem implements VersioningSystem {
             else
                 this.build = Integer.parseUnsignedInt(build);
         } catch (NumberFormatException exception) {
-            throw new InvalidVersionStringException(this, versionString, "Failed converting one of the vectors to an integer.", exception);
+            throw new InvalidVersionStringException(this, versionString, "Failed converting one of the vectors to an integer", exception);
         }
     }
 

base/src/main/java/de/staropensource/sosengine/base/data/versioning/StarOpenSourceVersioningSystem.java

@@ -232,11 +232,11 @@ public final class StarOpenSourceVersioningSystem implements VersioningSystem {
             this.companion = companion;
             this.fork = fork;
         } catch (NumberFormatException exception) {
-            throw new InvalidVersionStringException(this, versionString, "Failed converting one of the vectors to an integer.", exception);
+            throw new InvalidVersionStringException(this, versionString, "Failed converting one of the vectors to an integer", exception);
         }
 
         if (this.version == 0)
-            throw new InvalidVersionStringException(this, versionString, "The version vector must start at 1.");
+            throw new InvalidVersionStringException(this, versionString, "The version vector must start at 1");
     }
 
     /** {@inheritDoc} */

base/src/main/java/de/staropensource/sosengine/base/data/versioning/ThreeNumberVersioningSystem.java

@@ -94,7 +94,7 @@ public final class ThreeNumberVersioningSystem implements VersioningSystem {
         // Escape separator or throw error if invalid
         switch (separator) {
             case "." -> separator = "\\.";
-            case null -> throw new InvalidVersionStringException(this, versionString, "No matching separator could be found. Required are either two dots ('.') or hyphens ('-').");
+            case null -> throw new InvalidVersionStringException(this, versionString, "No matching separator could be found. Required are either two dots ('.') or hyphens ('-')");
             default -> {}
         }
 
@@ -107,7 +107,7 @@ public final class ThreeNumberVersioningSystem implements VersioningSystem {
             this.number2 = Integer.parseUnsignedInt(versionStringSplit[1]);
             this.number3 = Integer.parseUnsignedInt(versionStringSplit[2]);
         } catch (NumberFormatException exception) {
-            throw new InvalidVersionStringException(this, versionString, "Failed converting one of the vectors to an integer.", exception);
+            throw new InvalidVersionStringException(this, versionString, "Failed converting one of the vectors to an integer", exception);
         }
     }
 

base/src/main/java/de/staropensource/sosengine/base/data/versioning/package-info.java

@@ -0,0 +1,26 @@
+/*
+ * STAROPENSOURCE ENGINE SOURCE FILE
+ * Copyright (c) 2024 The StarOpenSource Engine Contributors
+ * Licensed under the GNU Affero General Public License v3
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/**
+ * Contains built-in versioning systems that
+ * can be used to represent versions of some work.
+ *
+ * @since 1-alpha1
+ */
+package de.staropensource.sosengine.base.data.versioning;

base/src/main/java/de/staropensource/sosengine/base/events/package-info.java

@@ -0,0 +1,25 @@
+/*
+ * STAROPENSOURCE ENGINE SOURCE FILE
+ * Copyright (c) 2024 The StarOpenSource Engine Contributors
+ * Licensed under the GNU Affero General Public License v3
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/**
+ * Contains events. There's nothing more to say.
+ *
+ * @since 1-alpha1
+ */
+package de.staropensource.sosengine.base.events;

base/src/main/java/de/staropensource/sosengine/base/exceptions/package-info.java

@@ -0,0 +1,25 @@
+/*
+ * STAROPENSOURCE ENGINE SOURCE FILE
+ * Copyright (c) 2024 The StarOpenSource Engine Contributors
+ * Licensed under the GNU Affero General Public License v3
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/**
+ * Contains exceptions thrown by the engine.
+ *
+ * @since 1-alpha1
+ */
+package de.staropensource.sosengine.base.exceptions;

base/src/main/java/de/staropensource/sosengine/base/internal/package-info.java

@@ -18,7 +18,7 @@
  */
 
 /**
- * Contains internal packages.
+ * Contains engine-internal stuff, not part of the API.
  *
  * @since 1-alpha1
  */

base/src/main/java/de/staropensource/sosengine/base/internal/types/package-info.java

@@ -0,0 +1,26 @@
+/*
+ * STAROPENSOURCE ENGINE SOURCE FILE
+ * Copyright (c) 2024 The StarOpenSource Engine Contributors
+ * Licensed under the GNU Affero General Public License v3
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/**
+ * Contains engine-internal data types, usually for passing
+ * data around classes more efficiently.
+ *
+ * @since 1-alpha1
+ */
+package de.staropensource.sosengine.base.internal.types;

base/src/main/java/de/staropensource/sosengine/base/logging/implementation/package-info.java

@@ -0,0 +1,26 @@
+/*
+ * STAROPENSOURCE ENGINE SOURCE FILE
+ * Copyright (c) 2024 The StarOpenSource Engine Contributors
+ * Licensed under the GNU Affero General Public License v3
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/**
+ * Contains a set of built-in logger implementations
+ * that all print log output a bit differently.
+ *
+ * @since 1-alpha1
+ */
+package de.staropensource.sosengine.base.logging.implementation;

base/src/main/java/de/staropensource/sosengine/base/utility/converter/package-info.java

@@ -0,0 +1,25 @@
+/*
+ * STAROPENSOURCE ENGINE SOURCE FILE
+ * Copyright (c) 2024 The StarOpenSource Engine Contributors
+ * Licensed under the GNU Affero General Public License v3
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/**
+ * Classes in the package convert data to some other data.
+ *
+ * @since 1-alpha1
+ */
+package de.staropensource.sosengine.base.utility.converter;

base/src/main/java/de/staropensource/sosengine/base/utility/package-info.java

@@ -18,7 +18,7 @@
  */
 
 /**
- * Provides various utility classes specifically made for one task.
+ * Provides (utility) classes specifically made for one task.
  *
  * @see de.staropensource.sosengine.base.utility.Miscellaneous
  * @since 1-alpha0

base/src/main/java/de/staropensource/sosengine/base/utility/parser/package-info.java

@@ -0,0 +1,26 @@
+/*
+ * STAROPENSOURCE ENGINE SOURCE FILE
+ * Copyright (c) 2024 The StarOpenSource Engine Contributors
+ * Licensed under the GNU Affero General Public License v3
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/**
+ * Classes in this package handle parsing data
+ * and providing that parsed data in simple ways.
+ *
+ * @since 1-alpha1
+ */
+package de.staropensource.sosengine.base.utility.parser;