docs: Begin adding javadocs

Almighty-Satan · Sep 5, 2023 · 6ab874b · 6ab874b
1 parent 1f9ff36
commit 6ab874b
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 0 deletions.
diff --git a/core/src/main/java/io/github/almightysatan/slams/Context.java b/core/src/main/java/io/github/almightysatan/slams/Context.java
@@ -22,6 +22,9 @@
 
 import org.jetbrains.annotations.Nullable;
 
+/**
+ * Provides additional context for language entries.
+ */
 public interface Context {
 
     @Nullable Language language();

diff --git a/minimessage/src/main/java/io/github/almightysatan/slams/minimessage/MMStringArrayEntry.java b/minimessage/src/main/java/io/github/almightysatan/slams/minimessage/MMStringArrayEntry.java
@@ -32,8 +32,20 @@
 import java.util.Arrays;
 import java.util.List;
 
+/**
+ * {@link MMStringArrayEntry}s represent a {@link String} array in a language file parsed in MiniMessage format.
+ * They can be used to get a {@link Component} array.
+ */
 public interface MMStringArrayEntry extends MMLanguageEntry<Component[]> {
 
+    /**
+     * Creates a new {@link MMStringArrayEntry} with the given path, {@link LanguageManager} and {@link ContextTagResolver}.
+     *
+     * @param path            the path of the entry
+     * @param languageManager the language manager
+     * @param tagResolver     the tag resolver
+     * @return the created entry
+     */
     static @NotNull MMStringArrayEntry of(@NotNull String path, @NotNull LanguageManager languageManager, @Nullable ContextTagResolver<Context> tagResolver) {
         class MMStringArrayEntryImpl extends AbstractMMLanguageEntry<String[]> implements MMStringArrayEntry {
 
@@ -55,6 +67,12 @@ protected String[] checkType(@Nullable Object value) throws InvalidTypeException
                 throw new InvalidTypeException();
             }
 
+            /**
+             * Returns the value of this entry as a {@link Component} array.
+             * @param context       the context
+             * @param tagResolver   the tag resolver
+             * @return the value of this entry as a {@link Component} array
+             */
             @Override
             public @NotNull Component @NotNull [] value(@Nullable Context context, @NotNull ContextTagResolver<Context> tagResolver) {
                 Object value = this.rawValue(context);

diff --git a/minimessage/src/main/java/io/github/almightysatan/slams/minimessage/MMStringEntry.java b/minimessage/src/main/java/io/github/almightysatan/slams/minimessage/MMStringEntry.java
@@ -29,8 +29,21 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+/**
+ * {@link MMStringEntry}s represent a {@link String} in a language file parsed in MiniMessage format.
+ * They can be used to get a {@link Component}.
+ */
 public interface MMStringEntry extends MMLanguageEntry<Component> {
 
+    /**
+     * Creates a new {@link MMStringEntry} with the given path, {@link LanguageManager} and {@link ContextTagResolver}.
+     * If
+     *
+     * @param path            the path of the entry
+     * @param languageManager the language manager
+     * @param tagResolver     the tag resolver
+     * @return the created entry
+     */
     static @NotNull MMStringEntry of(@NotNull String path, @NotNull LanguageManager languageManager, @Nullable ContextTagResolver<Context> tagResolver) {
         class MMStringEntryImpl extends AbstractMMLanguageEntry<String> implements MMStringEntry {
 
@@ -45,6 +58,12 @@ protected String checkType(@Nullable Object value) throws InvalidTypeException {
                 return (String) value;
             }
 
+            /**
+             * Returns the value of this entry as a {@link Component}.
+             * @param context       the context
+             * @param tagResolver   the tag resolver
+             * @return the value of this entry as a {@link Component}
+             */
             @Override
             public @NotNull Component value(@Nullable Context context, @NotNull ContextTagResolver<Context> tagResolver) {
                 String value = this.rawValue(context);