mirror of
https://github.com/StarWishsama/Slimefun4.git
synced 2024-09-19 11:15:51 +00:00
Fixes Javadocs build & adds workflow to ensure no more breakages (#4168)
This commit is contained in:
parent
f4581e4d9e
commit
03e5b9ab1e
37
.github/workflows/javadocs.yml
vendored
Normal file
37
.github/workflows/javadocs.yml
vendored
Normal file
@ -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
|
1
.gitignore
vendored
1
.gitignore
vendored
@ -6,6 +6,7 @@
|
|||||||
/.idea/
|
/.idea/
|
||||||
/.vscode/
|
/.vscode/
|
||||||
/data-storage/
|
/data-storage/
|
||||||
|
/javadocs/
|
||||||
|
|
||||||
dependency-reduced-pom.xml
|
dependency-reduced-pom.xml
|
||||||
|
|
||||||
|
2
pom.xml
2
pom.xml
@ -239,7 +239,7 @@
|
|||||||
|
|
||||||
<configuration>
|
<configuration>
|
||||||
<reportOutputDirectory>${project.basedir}</reportOutputDirectory>
|
<reportOutputDirectory>${project.basedir}</reportOutputDirectory>
|
||||||
<destDir>docs</destDir>
|
<destDir>javadocs</destDir>
|
||||||
|
|
||||||
<doctitle>Slimefun4 - Javadocs</doctitle>
|
<doctitle>Slimefun4 - Javadocs</doctitle>
|
||||||
<windowtitle>Slimefun4 - Javadocs</windowtitle>
|
<windowtitle>Slimefun4 - Javadocs</windowtitle>
|
||||||
|
@ -39,7 +39,7 @@ public final class ThreadService {
|
|||||||
* This is a much better alternative to using
|
* This is a much better alternative to using
|
||||||
* {@link BukkitScheduler#runTaskAsynchronously(org.bukkit.plugin.Plugin, Runnable)}
|
* {@link BukkitScheduler#runTaskAsynchronously(org.bukkit.plugin.Plugin, Runnable)}
|
||||||
* as this will show not only the plugin but a useful name.
|
* 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.
|
* it's impossible to track exactly what thread that is.
|
||||||
*
|
*
|
||||||
* @param plugin The {@link JavaPlugin} that is creating this thread
|
* @param plugin The {@link JavaPlugin} that is creating this thread
|
||||||
@ -60,7 +60,7 @@ public final class ThreadService {
|
|||||||
* This is a much better alternative to using
|
* This is a much better alternative to using
|
||||||
* {@link BukkitScheduler#runTaskTimerAsynchronously(org.bukkit.plugin.Plugin, Runnable, long, long)}
|
* {@link BukkitScheduler#runTaskTimerAsynchronously(org.bukkit.plugin.Plugin, Runnable, long, long)}
|
||||||
* as this will show not only the plugin but a useful name.
|
* 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.
|
* it's impossible to track exactly what thread that is.
|
||||||
*
|
*
|
||||||
* @param plugin The {@link JavaPlugin} that is creating this thread
|
* @param plugin The {@link JavaPlugin} that is creating this thread
|
||||||
|
Loading…
Reference in New Issue
Block a user