GH-951 Refactor Docs Automation. (#951)

Author: vLuckyyy

eternalcore-core/src/main/java/com/eternalcode/core/bridge/litecommand/argument/PlayerArgument.java

@@ -1,6 +1,6 @@
 package com.eternalcode.core.bridge.litecommand.argument;
 
-import com.eternalcode.annotations.scan.feature.FeatureDocs;
+import com.eternalcode.annotations.scan.permission.PermissionDocs;
 import com.eternalcode.core.feature.vanish.VanishPermissionConstant;
 import com.eternalcode.core.feature.vanish.VanishService;
 import com.eternalcode.core.injector.annotations.Inject;
@@ -16,15 +16,8 @@
 import org.bukkit.command.CommandSender;
 import org.bukkit.entity.Player;
 
-import java.util.function.Predicate;
-
 @LiteArgument(type = Player.class)
 
-@FeatureDocs(
-    name = "Vanish tabulation",
-    description = "EternalCore prevents non-admin players from seeing vanished players in the commands like /tpa."
-        + " To re-enable this feature for specific players, grant them the eternalcore.vanish.tabulation.see permission."
-)
 public class PlayerArgument extends AbstractViewerArgument<Player> {
 
     private final Server server;

eternalcore-core/src/main/java/com/eternalcode/core/bridge/litecommand/configurator/CommandConfigurator.java

@@ -1,6 +1,6 @@
 package com.eternalcode.core.bridge.litecommand.configurator;
 
-import com.eternalcode.annotations.scan.feature.FeatureDocs;
+
 import com.eternalcode.core.bridge.litecommand.configurator.config.Command;
 import com.eternalcode.core.bridge.litecommand.configurator.config.CommandConfiguration;
 import com.eternalcode.core.bridge.litecommand.configurator.config.SubCommand;
@@ -21,11 +21,6 @@ class CommandConfigurator implements Editor<CommandSender> {
         this.commandConfiguration = commandConfiguration;
     }
 
-    @FeatureDocs(
-        name = "CommandConfigurator",
-        description = "Adds support for command configuration, which allows you to change the name, aliases, permissions and disable the command"
-    )
-
     @Override
     public CommandBuilder<CommandSender> edit(CommandBuilder<CommandSender> context) {
         Command command = this.commandConfiguration.commands.get(context.name());

eternalcore-core/src/main/java/com/eternalcode/core/bridge/placeholderapi/PlaceholderApiReplacer.java

@@ -1,14 +1,10 @@
 package com.eternalcode.core.bridge.placeholderapi;
 
-import com.eternalcode.annotations.scan.feature.FeatureDocs;
+
 import com.eternalcode.core.placeholder.PlaceholderReplacer;
 import me.clip.placeholderapi.PlaceholderAPI;
 import org.bukkit.entity.Player;
 
-@FeatureDocs(
-    name = "PlaceholderAPI",
-    description = "Adds support for PlaceholderAPI"
-)
 public class PlaceholderApiReplacer implements PlaceholderReplacer {
 
     @Override

eternalcore-core/src/main/java/com/eternalcode/core/configuration/ConfigurationBackupService.java

@@ -1,6 +1,6 @@
 package com.eternalcode.core.configuration;
 
-import com.eternalcode.annotations.scan.feature.FeatureDocs;
+
 import com.eternalcode.core.injector.annotations.Inject;
 import com.eternalcode.core.injector.annotations.component.Service;
 import org.apache.commons.io.FileUtils;
@@ -13,10 +13,6 @@
 import java.time.format.DateTimeParseException;
 import java.time.temporal.ChronoUnit;
 
-@FeatureDocs(
-    name = "Configuration Backup",
-    description = "Backs up the full configuration to prevent config destruction, backup is only 3 days back"
-)
 @Service
 public class ConfigurationBackupService {
 

eternalcore-core/src/main/java/com/eternalcode/core/database/DatabaseManager.java

@@ -1,6 +1,6 @@
 package com.eternalcode.core.database;
 
-import com.eternalcode.annotations.scan.feature.FeatureDocs;
+
 import com.eternalcode.core.configuration.implementation.PluginConfiguration;
 import com.google.common.base.Stopwatch;
 import com.j256.ormlite.dao.Dao;
@@ -16,10 +16,6 @@
 import java.util.concurrent.TimeUnit;
 import java.util.logging.Logger;
 
-@FeatureDocs(
-    name = "Database",
-    description = "Adds support for MySQL, MariaDB, PostgreSQL, SQLite and H2 databases"
-)
 public class DatabaseManager {
 
     private final PluginConfiguration config;

eternalcore-core/src/main/java/com/eternalcode/core/feature/adminchat/AdminChatCommand.java

@@ -1,6 +1,7 @@
 package com.eternalcode.core.feature.adminchat;
 
 import com.eternalcode.annotations.scan.command.DescriptionDocs;
+import com.eternalcode.annotations.scan.permission.PermissionDocs;
 import com.eternalcode.core.event.EventCaller;
 import com.eternalcode.core.feature.adminchat.event.AdminChatEvent;
 import com.eternalcode.core.injector.annotations.Inject;
@@ -16,9 +17,14 @@
 
 @Command(name = "adminchat", aliases = "ac")
 @Permission("eternalcore.adminchat")
+@PermissionDocs(
+    name = "Admin Chat spy",
+    permission = AdminChatCommand.ADMIN_CHAT_SPY_PERMISSION,
+    description = "Allows the player to see messages sent in admin chat by other players."
+)
 class AdminChatCommand {
 
-    private static final String ADMIN_CHAT_SPY_PERMISSION = "eternalcore.adminchat.spy";
+    static final String ADMIN_CHAT_SPY_PERMISSION = "eternalcore.adminchat.spy";
 
     private final NoticeService noticeService;
     private final EventCaller eventCaller;

eternalcore-core/src/main/java/com/eternalcode/core/feature/afk/AfkCommand.java

@@ -1,7 +1,10 @@
 package com.eternalcode.core.feature.afk;
 
+import static com.eternalcode.core.feature.afk.AfkCommand.AFK_BYPASS_PERMISSION;
+
 import com.eternalcode.annotations.scan.command.DescriptionDocs;
-import com.eternalcode.annotations.scan.feature.FeatureDocs;
+
+import com.eternalcode.annotations.scan.permission.PermissionDocs;
 import com.eternalcode.core.configuration.implementation.PluginConfiguration;
 import com.eternalcode.core.delay.Delay;
 import com.eternalcode.core.injector.annotations.Inject;
@@ -17,14 +20,14 @@
 
 @Command(name = "afk")
 @Permission("eternalcore.afk")
-@FeatureDocs(
-    name = "Afk",
-    permission = { "eternalcore.afk", "eternalcore.afk.bypass" },
-    description = "It allows you to mark yourself as AFK, or if you are AFK, eternalcore will mark you as AFK after some time"
+@PermissionDocs(
+    name = "Afk bypass",
+    permission = AFK_BYPASS_PERMISSION,
+    description = "Allows player to bypass AFK delay when using /afk command."
 )
 class AfkCommand {
 
-    private static final String AFK_BYPASS_PERMISSION = "eternalcore.afk.bypass";
+    static final String AFK_BYPASS_PERMISSION = "eternalcore.afk.bypass";
 
     private final NoticeService noticeService;
     private final PluginConfiguration pluginConfiguration;
@@ -40,7 +43,7 @@ class AfkCommand {
     }
 
     @Execute
-    @DescriptionDocs(description = "Marks you as AFK, if player has eternalcore.afk.bypass permission, eternalcore will ignore afk delay")
+    @DescriptionDocs(description = "Toggles AFK status for the player.")
     void execute(@Context Player player) {
         UUID uuid = player.getUniqueId();
 

eternalcore-core/src/main/java/com/eternalcode/core/feature/chat/ChatManagerController.java

@@ -1,6 +1,6 @@
 package com.eternalcode.core.feature.chat;
 
-import com.eternalcode.annotations.scan.feature.FeatureDocs;
+import com.eternalcode.annotations.scan.permission.PermissionDocs;
 import com.eternalcode.core.event.EventCaller;
 import static com.eternalcode.core.feature.chat.ChatManagerController.CHAT_BYPASS_PERMISSION;
 import static com.eternalcode.core.feature.chat.ChatManagerController.CHAT_SLOWMODE_BYPASS_PERMISSION;
@@ -18,10 +18,10 @@
 import org.bukkit.event.Listener;
 import org.bukkit.event.player.AsyncPlayerChatEvent;
 
-@FeatureDocs(
-    name = "ChatManager",
-    description = "It allows you to manage chat, with slowmode, chat clear, chat on/off etc.",
-    permission = {CHAT_SLOWMODE_BYPASS_PERMISSION, CHAT_BYPASS_PERMISSION}
+@PermissionDocs(
+    name = "Bypass chat slowmode or disabled chat",
+    description = "Allows you to bypass chat restrictions such as slowmode or disabled chat.",
+    permission = { CHAT_SLOWMODE_BYPASS_PERMISSION, CHAT_BYPASS_PERMISSION }
 )
 @Controller
 class ChatManagerController implements Listener {

eternalcore-core/src/main/java/com/eternalcode/core/feature/deathmessage/DeathMessageController.java

@@ -1,6 +1,6 @@
 package com.eternalcode.core.feature.deathmessage;
 
-import com.eternalcode.annotations.scan.feature.FeatureDocs;
+
 import com.eternalcode.commons.RandomElementUtil;
 import com.eternalcode.core.feature.vanish.VanishService;
 import com.eternalcode.core.injector.annotations.Inject;
@@ -16,10 +16,6 @@
 import org.bukkit.event.entity.EntityDamageEvent;
 import org.bukkit.event.entity.PlayerDeathEvent;
 
-@FeatureDocs(
-    description = "Send a message to all players when a player dies, you can configure the messages based on damage cause in configuration, see: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityDamageEvent.DamageCause.html for all damage causes",
-    name = "Player Death Message"
-)
 @Controller
 class DeathMessageController implements Listener {
 

eternalcore-core/src/main/java/com/eternalcode/core/feature/fullserverbypass/FullServerBypassController.java

@@ -1,6 +1,7 @@
 package com.eternalcode.core.feature.fullserverbypass;
 
-import com.eternalcode.annotations.scan.feature.FeatureDocs;
+
+import com.eternalcode.annotations.scan.permission.PermissionDocs;
 import com.eternalcode.core.injector.annotations.Inject;
 import com.eternalcode.core.injector.annotations.component.Controller;
 import com.eternalcode.core.translation.TranslationManager;
@@ -17,14 +18,16 @@
 
 import java.util.Optional;
 
-@FeatureDocs(
+@PermissionDocs(
     name = "Bypass Full Server",
     description = "This feature allows you to bypass the full server, example for vip rank.",
-    permission = "eternalcore.slot.bypass"
+    permission = FullServerBypassController.SLOT_BYPASS
 )
 @Controller
 class FullServerBypassController implements Listener {
 
+    static final String SLOT_BYPASS = "eternalcore.slot.bypass";
+
     private final TranslationManager translationManager;
     private final UserManager userManager;
     private final MiniMessage miniMessage;
@@ -41,7 +44,7 @@ void onLogin(PlayerLoginEvent event) {
         if (event.getResult() == PlayerLoginEvent.Result.KICK_FULL) {
             Player player = event.getPlayer();
 
-            if (player.hasPermission("eternalcore.slot.bypass")) {
+            if (player.hasPermission(SLOT_BYPASS)) {
                 event.allow();
 
                 return;