Fix Javadoc generation issues
All checks were successful
push-build-apidoc / generate-javadoc (push) Successful in 1m34s
push-build-apidoc / build (push) Successful in 1m37s

This commit is contained in:
JeremyStar™ 2024-09-06 01:42:39 +02:00
parent 51a51a6271
commit e12597e834
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
6 changed files with 42 additions and 0 deletions

View file

@ -42,9 +42,19 @@ public final class EngineBootstrapper {
*/ */
private static final LoggerInstance logger = new LoggerInstance.Builder().setClazz(EngineBootstrapper.class).setOrigin("ENGINEMC").build(); 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. * 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 * @since v1-alpha0
*/ */
public static void initialize(boolean disableMultithreading, @NotNull ShutdownHandler shutdownHandler, @NotNull LoggingAdapter loggingAdapter) { public static void initialize(boolean disableMultithreading, @NotNull ShutdownHandler shutdownHandler, @NotNull LoggingAdapter loggingAdapter) {

View file

@ -32,16 +32,26 @@ import org.jetbrains.annotations.NotNull;
*/ */
@EngineSubsystem @EngineSubsystem
public final class MinecraftSubsystem extends SubsystemClass { public final class MinecraftSubsystem extends SubsystemClass {
/**
* Constructs this class.
*
* @since v1-alpha0
*/
public MinecraftSubsystem() {}
/** {@inheritDoc} */
@Override @Override
public @NotNull String getName() { public @NotNull String getName() {
return "minecraft"; return "minecraft";
} }
/** {@inheritDoc} */
@Override @Override
public void initializeSubsystem() { public void initializeSubsystem() {
SubsystemInformation.update(); SubsystemInformation.update();
} }
/** {@inheritDoc} */
@Override @Override
public @NotNull DependencyVector getDependencyVector() throws IllegalStateException { public @NotNull DependencyVector getDependencyVector() throws IllegalStateException {
if (SubsystemInformation.getVersioningString() == null) if (SubsystemInformation.getVersioningString() == null)

View file

@ -36,6 +36,13 @@ import java.util.concurrent.TimeUnit;
* @since v1-alpha0 * @since v1-alpha0
*/ */
public class Command { public class Command {
/**
* Constructs this class.
*
* @since v1-alpha0
*/
public Command() {}
/** /**
* Executes the command. * Executes the command.
* *

View file

@ -39,6 +39,7 @@ public abstract class Player {
/** /**
* Sends a message to the player. * Sends a message to the player.
* *
* @param message message to send
* @since v1-alpha0 * @since v1-alpha0
*/ */
public abstract void message(@NotNull Component message); public abstract void message(@NotNull Component message);

View file

@ -30,6 +30,13 @@ import org.jetbrains.annotations.Nullable;
* A {@link LoggingAdapter} for the Bukkit API. * A {@link LoggingAdapter} for the Bukkit API.
*/ */
public class BukkitLoggingAdapter implements LoggingAdapter { public class BukkitLoggingAdapter implements LoggingAdapter {
/**
* Constructs this class.
*
* @since v1-alpha0
*/
public BukkitLoggingAdapter() {}
/** {@inheritDoc} */ /** {@inheritDoc} */
@Override @Override
public @Nullable String prePlaceholder(@NotNull LogLevel level, @NotNull Class<?> issuerClass, @NotNull String issuerOrigin, @Nullable String issuerMetadata, @NotNull String message, @NotNull String format) { public @Nullable String prePlaceholder(@NotNull LogLevel level, @NotNull Class<?> issuerClass, @NotNull String issuerOrigin, @Nullable String issuerMetadata, @NotNull String message, @NotNull String format) {

View file

@ -30,6 +30,13 @@ import org.jetbrains.annotations.NotNull;
* @since v1-alpha0 * @since v1-alpha0
*/ */
public class BukkitCommand implements CommandExecutor { public class BukkitCommand implements CommandExecutor {
/**
* Constructs this class.
*
* @since v1-alpha0
*/
public BukkitCommand() {}
/** {@inheritDoc} */ /** {@inheritDoc} */
@Override @Override
public boolean onCommand(@NotNull CommandSender sender, @NotNull org.bukkit.command.Command command, @NotNull String alias, @NotNull String[] arguments) { public boolean onCommand(@NotNull CommandSender sender, @NotNull org.bukkit.command.Command command, @NotNull String alias, @NotNull String[] arguments) {