From b45a8c9f9b67632cc8325f2cba4973c5c40d2491 Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Tue, 25 Jun 2024 02:07:46 +0200 Subject: [PATCH] Update some comments and log messages --- .../staropensource/sosengine/base/EngineConfiguration.java | 2 +- .../sosengine/graphics/GraphicsSubsystem.java | 2 +- .../sosengine/graphics/GraphicsSubsystemConfiguration.java | 6 +++--- .../sosengine/graphics/classes/ApiMainClass.java | 2 +- .../sosengine/graphics/classes/ApiManagementClass.java | 2 +- .../staropensource/sosengine/graphics/classes/Window.java | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/base/src/main/java/de/staropensource/sosengine/base/EngineConfiguration.java b/base/src/main/java/de/staropensource/sosengine/base/EngineConfiguration.java index 51bf17d..dbe3a59 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/EngineConfiguration.java +++ b/base/src/main/java/de/staropensource/sosengine/base/EngineConfiguration.java @@ -250,7 +250,7 @@ public final class EngineConfiguration implements SubsystemConfiguration { if (instance == null) instance = this; else - Logger.crash(new LogIssuer(getClass(), CodePart.ENGINE), "Tried reinitializing " + getClass().getName() + " twice"); + Logger.crash(new LogIssuer(getClass(), CodePart.ENGINE), "Tried initializing " + getClass().getName() + " twice"); loadDefaultConfiguration(); } diff --git a/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystem.java b/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystem.java index a32cdf9..ee669b9 100644 --- a/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystem.java +++ b/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystem.java @@ -137,7 +137,7 @@ public final class GraphicsSubsystem implements SubsystemMainClass { } /** - * Shuts the graphics subsystem down. + * Shuts the subsystem down. * * @since 1-alpha0 */ diff --git a/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystemConfiguration.java b/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystemConfiguration.java index 7cbb56e..84904ec 100644 --- a/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystemConfiguration.java +++ b/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystemConfiguration.java @@ -31,7 +31,7 @@ import org.jetbrains.annotations.Nullable; import java.util.Properties; /** - * Provides the engine configuration for all classes in a centralized place. + * Provides the subsystem configuration for all classes in a centralized place. * * @since 1-alpha0 */ @@ -69,7 +69,7 @@ public final class GraphicsSubsystemConfiguration implements SubsystemConfigurat /** * If enabled, allows for unintentional behaviour and excess logging.
- * Unless you want to debug or work on a sensitive part of the graphics subsystem, don't enable this! + * Unless you want to debug or work on a sensitive part of the subsystem, don't enable this! * * @since 1-alpha0 * @@ -108,7 +108,7 @@ public final class GraphicsSubsystemConfiguration implements SubsystemConfigurat if (instance == null) instance = this; else - Logger.crash(new LogIssuer(getClass(), CodePart.ENGINE), "Tried reinitializing " + getClass().getName() + " twice"); + Logger.crash(new LogIssuer(getClass(), CodePart.ENGINE), "Tried initializing " + getClass().getName() + " twice"); loadDefaultConfiguration(); } diff --git a/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/ApiMainClass.java b/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/ApiMainClass.java index 9e427e5..43f9d80 100644 --- a/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/ApiMainClass.java +++ b/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/ApiMainClass.java @@ -50,7 +50,7 @@ public interface ApiMainClass extends SubsystemMainClass { String getApiName(); /** - * Returns the Graphics API's management class. + * Returns the API's management class. * * @return a {@link ApiManagementClass} * @see ApiManagementClass diff --git a/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/ApiManagementClass.java b/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/ApiManagementClass.java index f9898fd..598b3f4 100644 --- a/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/ApiManagementClass.java +++ b/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/ApiManagementClass.java @@ -27,7 +27,7 @@ import org.jetbrains.annotations.NotNull; * * @since 1-alpha0 */ -@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) +@SuppressWarnings({ "unused" }) public interface ApiManagementClass { /** * Creates a new {@link Window}. diff --git a/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/Window.java b/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/Window.java index fbb818c..690485a 100644 --- a/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/Window.java +++ b/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/Window.java @@ -30,7 +30,7 @@ import java.util.Set; * * @since 1-alpha0 */ -@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) +@SuppressWarnings({ "unused" }) public interface Window { /** * A set of all active windows.