Fixes Javadocs build & adds workflow to ensure no more breakages (#4168)

WalshyDev · web-flow · commit 03e5b9ab1e6b · 2024-04-05T20:36:56.000+01:00
diff --git a/.github/workflows/javadocs.yml b/.github/workflows/javadocs.yml
@@ -0,0 +1,37 @@
+name: Javadocs
+
+on:
+  push:
+    paths:
+    - 'src/**'
+    - 'pom.xml'
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Maven build
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Set up JDK 17
+      uses: actions/setup-java@v4.0.0
+      with:
+        distribution: 'adopt'
+        java-version: '17'
+        java-package: jdk
+        architecture: x64
+
+    - name: Cache Maven packages
+      uses: actions/cache@v4
+      with:
+        path: ~/.m2
+        key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+        restore-keys: ${{ runner.os }}-m2
+
+    - name: Build Javadocs
+      run: mvn javadoc:javadoc
diff --git a/.gitignore b/.gitignore
@@ -6,6 +6,7 @@
 /.idea/
 /.vscode/
 /data-storage/
+/javadocs/
 
 dependency-reduced-pom.xml
 
diff --git a/pom.xml b/pom.xml
@@ -239,7 +239,7 @@
 
                 <configuration>
                     <reportOutputDirectory>${project.basedir}</reportOutputDirectory>
-                    <destDir>docs</destDir>
+                    <destDir>javadocs</destDir>
 
                     <doctitle>Slimefun4 - Javadocs</doctitle>
                     <windowtitle>Slimefun4 - Javadocs</windowtitle>
diff --git a/src/main/java/io/github/thebusybiscuit/slimefun4/core/services/ThreadService.java b/src/main/java/io/github/thebusybiscuit/slimefun4/core/services/ThreadService.java
@@ -39,7 +39,7 @@ public Thread newThread(Runnable r) {
      * This is a much better alternative to using
      * {@link BukkitScheduler#runTaskAsynchronously(org.bukkit.plugin.Plugin, Runnable)}
      * as this will show not only the plugin but a useful name.
-     * By default, Bukkit will use "Craft Scheduler Thread - <x> - <plugin>" which is nice to show the plugin but
+     * By default, Bukkit will use "Craft Scheduler Thread - {@literal <x>} - {@literal <plugin>}" which is nice to show the plugin but
      * it's impossible to track exactly what thread that is.
      *
      * @param plugin The {@link JavaPlugin} that is creating this thread
@@ -60,7 +60,7 @@ public void newThread(JavaPlugin plugin, String name, Runnable runnable) {
      * This is a much better alternative to using
      * {@link BukkitScheduler#runTaskTimerAsynchronously(org.bukkit.plugin.Plugin, Runnable, long, long)}
      * as this will show not only the plugin but a useful name.
-     * By default, Bukkit will use "Craft Scheduler Thread - <x> - <plugin>" which is nice to show the plugin but
+     * By default, Bukkit will use "Craft Scheduler Thread - {@literal <x>} - {@literal <plugin>}" which is nice to show the plugin but
      * it's impossible to track exactly what thread that is.
      *
      * @param plugin The {@link JavaPlugin} that is creating this thread
