From ff7c559a39db960adba6c0a76044f94c1c7709e2 Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Thu, 11 Jul 2024 14:31:32 +0200 Subject: [PATCH] Add & update package-info.java files --- .../base/annotations/EngineSubsystem.java | 2 +- .../base/annotations/EventListener.java | 2 +- .../base/annotations/package-info.java | 3 ++- .../base/classes/helpers/package-info.java | 3 ++- .../base/data/info/package-info.java | 2 ++ .../FourNumberVersioningSystem.java | 4 +-- .../versioning/SemanticVersioningSystem.java | 4 +-- .../StarOpenSourceVersioningSystem.java | 4 +-- .../ThreeNumberVersioningSystem.java | 4 +-- .../base/data/versioning/package-info.java | 26 +++++++++++++++++++ .../sosengine/base/events/package-info.java | 25 ++++++++++++++++++ .../base/exceptions/package-info.java | 25 ++++++++++++++++++ .../sosengine/base/internal/package-info.java | 2 +- .../base/internal/types/package-info.java | 26 +++++++++++++++++++ .../logging/implementation/package-info.java | 26 +++++++++++++++++++ .../base/utility/converter/package-info.java | 25 ++++++++++++++++++ .../sosengine/base/utility/package-info.java | 2 +- .../base/utility/parser/package-info.java | 26 +++++++++++++++++++ 18 files changed, 197 insertions(+), 14 deletions(-) create mode 100644 base/src/main/java/de/staropensource/sosengine/base/data/versioning/package-info.java create mode 100644 base/src/main/java/de/staropensource/sosengine/base/events/package-info.java create mode 100644 base/src/main/java/de/staropensource/sosengine/base/exceptions/package-info.java create mode 100644 base/src/main/java/de/staropensource/sosengine/base/internal/types/package-info.java create mode 100644 base/src/main/java/de/staropensource/sosengine/base/logging/implementation/package-info.java create mode 100644 base/src/main/java/de/staropensource/sosengine/base/utility/converter/package-info.java create mode 100644 base/src/main/java/de/staropensource/sosengine/base/utility/parser/package-info.java diff --git a/base/src/main/java/de/staropensource/sosengine/base/annotations/EngineSubsystem.java b/base/src/main/java/de/staropensource/sosengine/base/annotations/EngineSubsystem.java index c09759f6..92db05b7 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/annotations/EngineSubsystem.java +++ b/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 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/annotations/EventListener.java b/base/src/main/java/de/staropensource/sosengine/base/annotations/EventListener.java index 8dc1d29b..1e571a53 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/annotations/EventListener.java +++ b/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 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/annotations/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/annotations/package-info.java index ec3f0c19..04f8eb70 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/annotations/package-info.java +++ b/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 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/classes/helpers/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/classes/helpers/package-info.java index 8d23bff6..f7360bb2 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/classes/helpers/package-info.java +++ b/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 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/info/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/data/info/package-info.java index 9df0a6e9..cda374f5 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/info/package-info.java +++ b/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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/FourNumberVersioningSystem.java b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/FourNumberVersioningSystem.java index b0d87a7b..e592d4d4 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/FourNumberVersioningSystem.java +++ b/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); } } diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/SemanticVersioningSystem.java b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/SemanticVersioningSystem.java index e5df3ac6..290ab136 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/SemanticVersioningSystem.java +++ b/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); } } diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/StarOpenSourceVersioningSystem.java b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/StarOpenSourceVersioningSystem.java index 63e79528..fa492212 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/StarOpenSourceVersioningSystem.java +++ b/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} */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/ThreeNumberVersioningSystem.java b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/ThreeNumberVersioningSystem.java index c9b4fb0e..4882bd8e 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/ThreeNumberVersioningSystem.java +++ b/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); } } diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/package-info.java new file mode 100644 index 00000000..163a93e2 --- /dev/null +++ b/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 . + */ + +/** + * 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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/events/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/events/package-info.java new file mode 100644 index 00000000..67ba5838 --- /dev/null +++ b/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 . + */ + +/** + * Contains events. There's nothing more to say. + * + * @since 1-alpha1 + */ +package de.staropensource.sosengine.base.events; diff --git a/base/src/main/java/de/staropensource/sosengine/base/exceptions/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/exceptions/package-info.java new file mode 100644 index 00000000..77d8919d --- /dev/null +++ b/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 . + */ + +/** + * Contains exceptions thrown by the engine. + * + * @since 1-alpha1 + */ +package de.staropensource.sosengine.base.exceptions; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/internal/package-info.java index cea87913..9a9cf565 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/package-info.java +++ b/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 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/types/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/internal/types/package-info.java new file mode 100644 index 00000000..99b2b2d1 --- /dev/null +++ b/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 . + */ + +/** + * Contains engine-internal data types, usually for passing + * data around classes more efficiently. + * + * @since 1-alpha1 + */ +package de.staropensource.sosengine.base.internal.types; diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/implementation/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/logging/implementation/package-info.java new file mode 100644 index 00000000..d495ecd8 --- /dev/null +++ b/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 . + */ + +/** + * 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; diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/converter/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/utility/converter/package-info.java new file mode 100644 index 00000000..844a195c --- /dev/null +++ b/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 . + */ + +/** + * Classes in the package convert data to some other data. + * + * @since 1-alpha1 + */ +package de.staropensource.sosengine.base.utility.converter; diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/utility/package-info.java index b2855546..88d6b42f 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/utility/package-info.java +++ b/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 diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/parser/package-info.java b/base/src/main/java/de/staropensource/sosengine/base/utility/parser/package-info.java new file mode 100644 index 00000000..3efd14e4 --- /dev/null +++ b/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 . + */ + +/** + * 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;