From fe632d92878452c636d5d7d5fe7e86fc6d70064f Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Sat, 8 Jun 2024 17:10:20 +0200 Subject: [PATCH] Update annotations and fix javadoc warnings --- .../sosengine/base/logging/DefaultLoggerImpl.java | 1 + .../java/de/staropensource/sosengine/base/logging/Logger.java | 2 +- .../de/staropensource/sosengine/base/types/VersionType.java | 2 +- .../staropensource/sosengine/base/utility/PropertyParser.java | 2 +- .../sosengine/base/utility/ShortcodeConverter.java | 2 +- 5 files changed, 5 insertions(+), 4 deletions(-) diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/DefaultLoggerImpl.java b/base/src/main/java/de/staropensource/sosengine/base/logging/DefaultLoggerImpl.java index d4fc959..a583418 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/DefaultLoggerImpl.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/DefaultLoggerImpl.java @@ -35,6 +35,7 @@ import org.jetbrains.annotations.NotNull; * @see LoggerImpl * @since 1-alpha0 */ +@SuppressWarnings("resource") public class DefaultLoggerImpl implements LoggerImpl { /** * Constructor. diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/Logger.java b/base/src/main/java/de/staropensource/sosengine/base/logging/Logger.java index 20e0124..2857d75 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/Logger.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/Logger.java @@ -41,7 +41,7 @@ import java.util.List; * @see LogIssuer * @see LogLevel */ -@SuppressWarnings({ "unused", "JavadocDeclaration" }) +@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) public class Logger { /** * Refers to the active {@link LoggerImpl} that is used to process and print log messages. diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/VersionType.java b/base/src/main/java/de/staropensource/sosengine/base/types/VersionType.java index 935fdd0..534f8ba 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/VersionType.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/VersionType.java @@ -24,7 +24,7 @@ import de.staropensource.sosengine.base.utility.BuildInfo; /** * Provides all available version types. * - * @see BuildInfo#getVersioningType() + * @see BuildInfo#versioningType * @since 1-alpha0 */ @SuppressWarnings({ "unused" }) diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/PropertyParser.java b/base/src/main/java/de/staropensource/sosengine/base/utility/PropertyParser.java index cdac708..10d2e15 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/utility/PropertyParser.java +++ b/base/src/main/java/de/staropensource/sosengine/base/utility/PropertyParser.java @@ -32,7 +32,7 @@ import java.util.Properties; * @see Properties * @since 1-alpha0 */ -@SuppressWarnings({ "unused", "JavadocDeclaration" }) +@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) @NotNull public final class PropertyParser { /** diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/ShortcodeConverter.java b/base/src/main/java/de/staropensource/sosengine/base/utility/ShortcodeConverter.java index 5bbf0a6..bca8fe4 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/utility/ShortcodeConverter.java +++ b/base/src/main/java/de/staropensource/sosengine/base/utility/ShortcodeConverter.java @@ -81,7 +81,7 @@ public class ShortcodeConverter { * @param text the text to process * @param noErrors prevents printing tag/shortcode errors, overrides the engine configuration setting * @return {@link Ansi} sequence - * @see EngineConfiguration#isErrorShortcodeConverter() + * @see EngineConfiguration#errorShortcodeConverter * @since 1-alpha0 */ @NotNull