Improve javadocs with <group> tags. (#6304)

* Group packages in Javadocs Allows for easier navigation of Javadocs Tested-by: Gabriel Arriagada <65878291+gnosii@users.noreply.github.com> * Replace plain link with "a" tag Allows for interaction with the link. Tested-by: Gabriel Arriagada <65878291+gnosii@users.noreply.github.com> * Go back in time Goes back to hard-coded Java 16 as requested by LlmDl
TownyAdvanced · Nov 14, 2022 · a5889fd · a5889fd
1 parent 8adb1b3
commit a5889fd
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 4 deletions.
diff --git a/pom.xml b/pom.xml
@@ -259,6 +259,41 @@
                 <configuration>
                     <source>16</source>
                     <doclint>all,-missing</doclint>
+                    <doctitle>Towny - ${project.version}</doctitle>
+                    <groups>
+                        <group>
+                            <title>Events</title>
+                            <packages>com.palmergames.bukkit.towny.event*</packages>
+                        </group>
+                        <group>
+                            <title>Objects</title>
+                            <packages>com.palmergames.bukkit.towny.object*</packages>
+                        </group>
+                        <group>
+                            <title>Tasks</title>
+                            <packages>com.palmergames.bukkit.towny.regen*:com.palmergames.bukkit.towny.tasks</packages>
+                        </group>
+                        <group>
+                            <title>Plugin</title>
+                            <packages>com.palmergames.bukkit.towny.command*:com.palmergames.bukkit.towny.listeners*:com.palmergames.bukkit.towny:com.palmergames.bukkit.config*:com.palmergames.bukkit.towny.db*</packages>
+                        </group>
+                        <group>
+                            <title>Player</title>
+                            <packages>com.palmergames.bukkit.towny.confirmations:com.palmergames.bukkit.towny.invites:com.palmergames.bukkit.towny.conversation:com.palmergames.bukkit.towny.huds</packages>
+                        </group>
+                        <group>
+                            <title>Hooks</title>
+                            <packages>com.palmergames.bukkit.towny.permissions:com.palmergames.bukkit.towny.hooks:com.palmergames.bukkit.towny.chat*</packages>
+                        </group>
+                        <group>
+                            <title>Exceptions</title>
+                            <packages>com.palmergames.bukkit.towny.exceptions*:com.palmergames.bukkit.towny.invites.exceptions</packages>
+                        </group>
+                        <group>
+                            <title>Utilities</title>
+                            <packages>com.palmergames.annotations:com.palmergames.util:com.palmergames.bukkit.util:com.palmergames.bukkit.towny.utils</packages>
+                        </group>
+                    </groups>
                 </configuration>
             </plugin>
             <plugin>  <!-- Create sources.jar -->

diff --git a/src/com/palmergames/bukkit/towny/Towny.java b/src/com/palmergames/bukkit/towny/Towny.java
@@ -94,10 +94,7 @@
 import java.util.logging.Level;
 
 /**
- * Towny Plugin for Bukkit
- * 
- * Website &amp; Source: https://github.com/TownyAdvanced/Towny
- * 
+ * Main class for <a href="https://github.com/TownyAdvanced/Towny">Towny</a>
  * @author Shade, ElgarL, LlmDl
  */
 public class Towny extends JavaPlugin {