add Javadoc and source JAR generation to build configuration; enhance GuildProvider interface documentation

Author: leo18bernese

.idea/misc.xml

@@ -21,6 +21,11 @@ repositories {
     maven { url 'https://jitpack.io' }
 }
 
+java {
+    withJavadocJar()
+    withSourcesJar()
+}
+
 dependencies {
     compileOnly 'org.projectlombok:lombok:1.18.30'
 
@@ -48,6 +53,7 @@ shadowJar {
         exclude(dependency('net.wesjd:.*'))
     }
 
+    finalizedBy javadocJar
     finalizedBy publishToMavenLocal
 }
 

build.gradle

@@ -5,9 +5,24 @@
 import java.util.List;
 import java.util.UUID;
 
+/**
+ * GuildProvider interface for managing guilds.
+ * Provides methods to retrieve, create, and manipulate guilds.
+ */
 public interface GuildProvider {
 
+    /**
+     * Get a guild by its UUID.
+     * @param uuid of the guild
+     * @return GuildView if found, null otherwise
+     */
     GuildView getByUuid(UUID uuid);
+
+    /**
+     * Get a guild by its name.
+     * @param name of the guild
+     * @return GuildView if found, null otherwise
+     */
     GuildView getByName(String name);
     GuildView getByPlayer(Player player);
     GuildView getByPlayer(UUID player);