From 0f0030916fc38f7e559773849778e7f4b13923a7 Mon Sep 17 00:00:00 2001 From: Alexander Brandes Date: Wed, 11 Jan 2023 18:25:51 +0100 Subject: [PATCH] Add source documentation to javadocs and add dependency tab (#3917) Get the most out of javadocs --- Bukkit/build.gradle.kts | 4 ++++ Core/build.gradle.kts | 4 ++++ .../java/com/plotsquared/core/events/PlayerAutoPlotEvent.java | 4 ++-- javadocfooter.html | 4 ++++ 4 files changed, 14 insertions(+), 2 deletions(-) create mode 100644 javadocfooter.html diff --git a/Bukkit/build.gradle.kts b/Bukkit/build.gradle.kts index d56c2d74d..181f412d7 100644 --- a/Bukkit/build.gradle.kts +++ b/Bukkit/build.gradle.kts @@ -105,6 +105,10 @@ tasks { opt.links("https://jd.adventure.kyori.net/api/4.9.3/") opt.links("https://google.github.io/guice/api-docs/" + libs.guice.get().versionConstraint.toString() + "/javadoc/") opt.links("https://checkerframework.org/api/") + opt.isLinkSource = true + opt.bottom(File("$rootDir/javadocfooter.html").readText()) + opt.isUse = true opt.encoding("UTF-8") + opt.keyWords() } } diff --git a/Core/build.gradle.kts b/Core/build.gradle.kts index aa7e541db..322ac6319 100644 --- a/Core/build.gradle.kts +++ b/Core/build.gradle.kts @@ -71,6 +71,10 @@ tasks { opt.links("https://google.github.io/guice/api-docs/" + libs.guice.get().versionConstraint.toString() + "/javadoc/") opt.links("https://checkerframework.org/api/") opt.links("https://javadoc.io/doc/com.intellectualsites.informative-annotations/informative-annotations/latest/") + opt.isLinkSource = true + opt.bottom(File("$rootDir/javadocfooter.html").readText()) + opt.isUse = true opt.encoding("UTF-8") + opt.keyWords() } } diff --git a/Core/src/main/java/com/plotsquared/core/events/PlayerAutoPlotEvent.java b/Core/src/main/java/com/plotsquared/core/events/PlayerAutoPlotEvent.java index 3fe14ce1b..03e9b10f9 100644 --- a/Core/src/main/java/com/plotsquared/core/events/PlayerAutoPlotEvent.java +++ b/Core/src/main/java/com/plotsquared/core/events/PlayerAutoPlotEvent.java @@ -114,7 +114,7 @@ public class PlayerAutoPlotEvent extends PlotEvent implements CancellablePlotEve } /** - * @deprecated for removal. Use {@link PlayerAutoPlotEvent#setSizeX(int)} )} + * @deprecated for removal. Use {@link PlayerAutoPlotEvent#setSizeX(int)} */ @Deprecated(forRemoval = true, since = "6.1.0") public void setSize_x(int sizeX) { @@ -130,7 +130,7 @@ public class PlayerAutoPlotEvent extends PlotEvent implements CancellablePlotEve } /** - * @deprecated for removal. Use {@link PlayerAutoPlotEvent#setSizeZ(int)} )} + * @deprecated for removal. Use {@link PlayerAutoPlotEvent#setSizeZ(int)} */ @Deprecated(forRemoval = true, since = "6.1.0") public void setSize_z(int sizeZ) { diff --git a/javadocfooter.html b/javadocfooter.html new file mode 100644 index 000000000..b6528c732 --- /dev/null +++ b/javadocfooter.html @@ -0,0 +1,4 @@ +Javadocs generated for + PlotSquared | + Documentation | +Visit us on our Discord server :)