From 9ea8b3003f7c9fd06d5cef01f7c72be7eff67a20 Mon Sep 17 00:00:00 2001 From: Almighty-Satan <43804777+Almighty-Satan@users.noreply.github.com> Date: Sun, 10 Mar 2024 09:46:31 +0100 Subject: [PATCH] Add more Javadoc --- .../java/io/github/almightysatan/slams/LanguageParser.java | 3 +++ .../almightysatan/slams/MissingTranslationException.java | 6 ++++++ .../io/github/almightysatan/slams/PlaceholderResolver.java | 3 +++ .../java/io/github/almightysatan/slams/TranslationMap.java | 1 + .../almightysatan/slams/UnknownLanguageException.java | 5 +++++ .../slams/minimessage/AdventureTranslationMap.java | 1 + .../almightysatan/slams/minimessage/ContextTagResolver.java | 3 +++ 7 files changed, 22 insertions(+) diff --git a/core/src/main/java/io/github/almightysatan/slams/LanguageParser.java b/core/src/main/java/io/github/almightysatan/slams/LanguageParser.java index 1432c77..d46e2c7 100644 --- a/core/src/main/java/io/github/almightysatan/slams/LanguageParser.java +++ b/core/src/main/java/io/github/almightysatan/slams/LanguageParser.java @@ -45,6 +45,9 @@ public interface LanguageParser { */ void load(@NotNull Values values) throws IOException; + /** + * Contains values provided by one or multiple {@link LanguageParser LanguageParsers}. + */ interface Values { /** * Returns a {@link Set} containing all valid paths. diff --git a/core/src/main/java/io/github/almightysatan/slams/MissingTranslationException.java b/core/src/main/java/io/github/almightysatan/slams/MissingTranslationException.java index 753f707..bee0bda 100644 --- a/core/src/main/java/io/github/almightysatan/slams/MissingTranslationException.java +++ b/core/src/main/java/io/github/almightysatan/slams/MissingTranslationException.java @@ -29,6 +29,12 @@ */ public class MissingTranslationException extends RuntimeException { + /** + * Creates a new {@link MissingTranslationException}. + * + * @param languageIdentifier the identifier of the language + * @param path the path of the missing translation + */ public MissingTranslationException(@NotNull String languageIdentifier, @NotNull String path) { super(String.format("Missing translation: %s in language %s", path, languageIdentifier)); } diff --git a/core/src/main/java/io/github/almightysatan/slams/PlaceholderResolver.java b/core/src/main/java/io/github/almightysatan/slams/PlaceholderResolver.java index 63b017f..a83afed 100644 --- a/core/src/main/java/io/github/almightysatan/slams/PlaceholderResolver.java +++ b/core/src/main/java/io/github/almightysatan/slams/PlaceholderResolver.java @@ -33,6 +33,9 @@ @FunctionalInterface public interface PlaceholderResolver { + /** + * A {@link PlaceholderResolver} that always returns null (does not resolve any {@link Placeholder Placeholders}). + */ PlaceholderResolver EMPTY = key -> null; /** diff --git a/core/src/main/java/io/github/almightysatan/slams/TranslationMap.java b/core/src/main/java/io/github/almightysatan/slams/TranslationMap.java index b1c5108..4d76949 100644 --- a/core/src/main/java/io/github/almightysatan/slams/TranslationMap.java +++ b/core/src/main/java/io/github/almightysatan/slams/TranslationMap.java @@ -27,6 +27,7 @@ /** * Represents a map of {@link Translation Translations}. * + * @param the type of the key * @param the type of this translation * @param the {@link Translation Translations} in this map */ diff --git a/core/src/main/java/io/github/almightysatan/slams/UnknownLanguageException.java b/core/src/main/java/io/github/almightysatan/slams/UnknownLanguageException.java index e5a5c3b..dd50668 100644 --- a/core/src/main/java/io/github/almightysatan/slams/UnknownLanguageException.java +++ b/core/src/main/java/io/github/almightysatan/slams/UnknownLanguageException.java @@ -27,6 +27,11 @@ */ public class UnknownLanguageException extends RuntimeException { + /** + * Creates a new {@link UnknownLanguageException}. + * + * @param languageIdentifier the unknown identifier + */ public UnknownLanguageException(@NotNull String languageIdentifier) { super(String.format("Unknown language: %s", languageIdentifier)); } diff --git a/minimessage/src/main/java/io/github/almightysatan/slams/minimessage/AdventureTranslationMap.java b/minimessage/src/main/java/io/github/almightysatan/slams/minimessage/AdventureTranslationMap.java index 59a5926..59713fd 100644 --- a/minimessage/src/main/java/io/github/almightysatan/slams/minimessage/AdventureTranslationMap.java +++ b/minimessage/src/main/java/io/github/almightysatan/slams/minimessage/AdventureTranslationMap.java @@ -27,6 +27,7 @@ /** * Represents a map of {@link AdventureTranslation AdventureTranslations}. * + * @param the type of the key * @param the type of this translation * @param the {@link AdventureTranslation AdventureTranslations} in this map */ diff --git a/minimessage/src/main/java/io/github/almightysatan/slams/minimessage/ContextTagResolver.java b/minimessage/src/main/java/io/github/almightysatan/slams/minimessage/ContextTagResolver.java index 7fee6ba..e1b1da3 100644 --- a/minimessage/src/main/java/io/github/almightysatan/slams/minimessage/ContextTagResolver.java +++ b/minimessage/src/main/java/io/github/almightysatan/slams/minimessage/ContextTagResolver.java @@ -38,6 +38,9 @@ */ public interface ContextTagResolver extends TagResolver { + /** + * A {@link ContextTagResolver} that does not resolve any tags. + */ ContextTagResolver EMPTY = new ContextTagResolver() { @Override public @Nullable Tag resolve(@TagPattern @NotNull String name, @NotNull ArgumentQueue arguments, net.kyori.adventure.text.minimessage.@NotNull Context ctx, @Nullable Context context) throws ParsingException {