From e12597e834bb2df9221d793b9106aaca3fa503e5 Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Fri, 6 Sep 2024 01:42:39 +0200 Subject: [PATCH] Fix Javadoc generation issues --- .../sosengine/minecraft/EngineBootstrapper.java | 10 ++++++++++ .../sosengine/minecraft/MinecraftSubsystem.java | 10 ++++++++++ .../sosengine/minecraft/command/Command.java | 7 +++++++ .../sosengine/minecraft/command/Player.java | 1 + .../minecraft/bukkit/BukkitLoggingAdapter.java | 7 +++++++ .../minecraft/bukkit/command/BukkitCommand.java | 7 +++++++ 6 files changed, 42 insertions(+) diff --git a/common/src/main/java/de/staropensource/sosengine/minecraft/EngineBootstrapper.java b/common/src/main/java/de/staropensource/sosengine/minecraft/EngineBootstrapper.java index c24621c..3442b8f 100644 --- a/common/src/main/java/de/staropensource/sosengine/minecraft/EngineBootstrapper.java +++ b/common/src/main/java/de/staropensource/sosengine/minecraft/EngineBootstrapper.java @@ -42,9 +42,19 @@ public final class EngineBootstrapper { */ private static final LoggerInstance logger = new LoggerInstance.Builder().setClazz(EngineBootstrapper.class).setOrigin("ENGINEMC").build(); + /** + * Constructs this class. + * + * @since v1-alpha0 + */ + public EngineBootstrapper() {} + /** * Initializes the engine and environment. * + * @param disableMultithreading disables multithreading support (except for logging), if enabled + * @param shutdownHandler {@link ShutdownHandler} implementation, which should ideally shutdown the server + * @param loggingAdapter {@link LoggingAdapter} implementation, for printing log messages into the server console * @since v1-alpha0 */ public static void initialize(boolean disableMultithreading, @NotNull ShutdownHandler shutdownHandler, @NotNull LoggingAdapter loggingAdapter) { diff --git a/common/src/main/java/de/staropensource/sosengine/minecraft/MinecraftSubsystem.java b/common/src/main/java/de/staropensource/sosengine/minecraft/MinecraftSubsystem.java index 262b101..3f3bd0e 100644 --- a/common/src/main/java/de/staropensource/sosengine/minecraft/MinecraftSubsystem.java +++ b/common/src/main/java/de/staropensource/sosengine/minecraft/MinecraftSubsystem.java @@ -32,16 +32,26 @@ import org.jetbrains.annotations.NotNull; */ @EngineSubsystem public final class MinecraftSubsystem extends SubsystemClass { + /** + * Constructs this class. + * + * @since v1-alpha0 + */ + public MinecraftSubsystem() {} + + /** {@inheritDoc} */ @Override public @NotNull String getName() { return "minecraft"; } + /** {@inheritDoc} */ @Override public void initializeSubsystem() { SubsystemInformation.update(); } + /** {@inheritDoc} */ @Override public @NotNull DependencyVector getDependencyVector() throws IllegalStateException { if (SubsystemInformation.getVersioningString() == null) diff --git a/common/src/main/java/de/staropensource/sosengine/minecraft/command/Command.java b/common/src/main/java/de/staropensource/sosengine/minecraft/command/Command.java index e35d7ed..c9188c4 100644 --- a/common/src/main/java/de/staropensource/sosengine/minecraft/command/Command.java +++ b/common/src/main/java/de/staropensource/sosengine/minecraft/command/Command.java @@ -36,6 +36,13 @@ import java.util.concurrent.TimeUnit; * @since v1-alpha0 */ public class Command { + /** + * Constructs this class. + * + * @since v1-alpha0 + */ + public Command() {} + /** * Executes the command. * diff --git a/common/src/main/java/de/staropensource/sosengine/minecraft/command/Player.java b/common/src/main/java/de/staropensource/sosengine/minecraft/command/Player.java index 9fca5e6..fda0536 100644 --- a/common/src/main/java/de/staropensource/sosengine/minecraft/command/Player.java +++ b/common/src/main/java/de/staropensource/sosengine/minecraft/command/Player.java @@ -39,6 +39,7 @@ public abstract class Player { /** * Sends a message to the player. * + * @param message message to send * @since v1-alpha0 */ public abstract void message(@NotNull Component message); diff --git a/platform-bukkit/src/main/java/de/staropensource/sosengine/minecraft/bukkit/BukkitLoggingAdapter.java b/platform-bukkit/src/main/java/de/staropensource/sosengine/minecraft/bukkit/BukkitLoggingAdapter.java index 6e88648..15b57fe 100644 --- a/platform-bukkit/src/main/java/de/staropensource/sosengine/minecraft/bukkit/BukkitLoggingAdapter.java +++ b/platform-bukkit/src/main/java/de/staropensource/sosengine/minecraft/bukkit/BukkitLoggingAdapter.java @@ -30,6 +30,13 @@ import org.jetbrains.annotations.Nullable; * A {@link LoggingAdapter} for the Bukkit API. */ public class BukkitLoggingAdapter implements LoggingAdapter { + /** + * Constructs this class. + * + * @since v1-alpha0 + */ + public BukkitLoggingAdapter() {} + /** {@inheritDoc} */ @Override public @Nullable String prePlaceholder(@NotNull LogLevel level, @NotNull Class issuerClass, @NotNull String issuerOrigin, @Nullable String issuerMetadata, @NotNull String message, @NotNull String format) { diff --git a/platform-bukkit/src/main/java/de/staropensource/sosengine/minecraft/bukkit/command/BukkitCommand.java b/platform-bukkit/src/main/java/de/staropensource/sosengine/minecraft/bukkit/command/BukkitCommand.java index 9446d39..0085351 100644 --- a/platform-bukkit/src/main/java/de/staropensource/sosengine/minecraft/bukkit/command/BukkitCommand.java +++ b/platform-bukkit/src/main/java/de/staropensource/sosengine/minecraft/bukkit/command/BukkitCommand.java @@ -30,6 +30,13 @@ import org.jetbrains.annotations.NotNull; * @since v1-alpha0 */ public class BukkitCommand implements CommandExecutor { + /** + * Constructs this class. + * + * @since v1-alpha0 + */ + public BukkitCommand() {} + /** {@inheritDoc} */ @Override public boolean onCommand(@NotNull CommandSender sender, @NotNull org.bukkit.command.Command command, @NotNull String alias, @NotNull String[] arguments) {