Add source documentation to javadocs and add dependency tab (Intellec…

…tualSites#3917) Get the most out of javadocs
Craftstuebchen · Jan 23, 2023 · da1bda9 · da1bda9
1 parent c16f5f3
commit da1bda9
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 2 deletions.
diff --git 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
@@ -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
@@ -114,7 +114,7 @@ public int getSize_x() {
     }
 
     /**
-     * @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 int getSize_z() {
     }
 
     /**
-     * @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
@@ -0,0 +1,4 @@
+Javadocs generated for
+<a rel="noopener nofollow noreferrer" href="https://github.com/IntellectualSites/PlotSquared/" target="_blank"> PlotSquared</a> |
+<a rel="noopener nofollow noreferrer" href="https://intellectualsites.github.io/plotsquared-documentation/"> Documentation </a> |
+Visit us on our <a rel="noopener nofollow noreferrer" href="https://discord.gg/intellectualsites"> Discord server</a> :)