From 2b689f8267f8273a755f9bd0b21c0f2920b86845 Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Thu, 27 Jun 2024 20:43:05 +0200 Subject: [PATCH] Fix a few javadoc issues --- .../sosengine/base/classes/logging/LogRule.java | 3 +++ .../sosengine/base/events/ThrowableCatchEvent.java | 3 +-- .../sosengine/graphics/vulkan/VulkanManagement.java | 5 +++++ 3 files changed, 9 insertions(+), 2 deletions(-) diff --git a/base/src/main/java/de/staropensource/sosengine/base/classes/logging/LogRule.java b/base/src/main/java/de/staropensource/sosengine/base/classes/logging/LogRule.java index a8bdd53..826743b 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/classes/logging/LogRule.java +++ b/base/src/main/java/de/staropensource/sosengine/base/classes/logging/LogRule.java @@ -48,6 +48,8 @@ public class LogRule { /** * Constructor. + * + * @param type rule type */ public LogRule(@NotNull LogRuleType type) { this.type = type; @@ -59,6 +61,7 @@ public class LogRule { * @param issuer issuer * @param level log level * @param message raw message + * @return if the rule matches */ public boolean evaluate(@NotNull LogIssuer issuer, @NotNull LogLevel level, @NotNull String message) { return false; diff --git a/base/src/main/java/de/staropensource/sosengine/base/events/ThrowableCatchEvent.java b/base/src/main/java/de/staropensource/sosengine/base/events/ThrowableCatchEvent.java index 2dff034..6d36324 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/events/ThrowableCatchEvent.java +++ b/base/src/main/java/de/staropensource/sosengine/base/events/ThrowableCatchEvent.java @@ -31,8 +31,7 @@ import java.lang.reflect.Method; /** * Called when an exception is caught. * - * @see Miscellaneous#exec - * @see Miscellaneous#executeSafely(Runnable) + * @see Miscellaneous#executeSafely(Runnable, String) * @since 1-alpha0 */ public class ThrowableCatchEvent implements Event { diff --git a/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/VulkanManagement.java b/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/VulkanManagement.java index 708f6e0..cad166a 100644 --- a/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/VulkanManagement.java +++ b/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/VulkanManagement.java @@ -24,6 +24,11 @@ import de.staropensource.sosengine.graphics.classes.ApiManagementClass; import de.staropensource.sosengine.graphics.classes.Window; import org.jetbrains.annotations.NotNull; +/** + * The Vulkan API management class. + * + * @since 1-alpha0 + */ public class VulkanManagement implements ApiManagementClass { /** * Constructor.